Schema (swagger-models 2.1.10 API)

java.lang.Object
- io.swagger.v3.oas.models.media.Schema<T>

Direct Known Subclasses:

ArraySchema, BinarySchema, BooleanSchema, ByteArraySchema, ComposedSchema, DateSchema, DateTimeSchema, EmailSchema, FileSchema, IntegerSchema, MapSchema, NumberSchema, ObjectSchema, PasswordSchema, StringSchema, UUIDSchema
```
public class Schema<T>
extends Object
```
Schema

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#schemaObject"

Field Summary

Fields
Modifier and Type Field and Description

protected T _default

protected List<T> _enum

protected T example

Fields
Modifier and Type	Field and Description
`protected T`	`_default`
`protected List<T>`	`_enum`
`protected T`	`example`

Constructor Summary

Constructors
Modifier Constructor and Description

Schema()

protected Schema(String type, String format)

Constructors
Modifier	Constructor and Description
	`Schema()`
`protected`	`Schema(String type, String format)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schema`	`$ref(String $ref)`
`void`	`addEnumItemObject(T _enumItem)`
`void`	`addExtension(String name, Object value)`
`Schema`	`additionalProperties(Object additionalProperties)`
`Schema`	`addProperties(String key, Schema propertiesItem)`
`Schema`	`addRequiredItem(String requiredItem)`
`protected T`	`cast(Object value)`
`Schema`	`deprecated(Boolean deprecated)`
`Schema`	`description(String description)`
`Schema`	`discriminator(Discriminator discriminator)`
`boolean`	`equals(Object o)`
`Schema`	`example(Object example)`
`Schema`	`exclusiveMaximum(Boolean exclusiveMaximum)`
`Schema`	`exclusiveMinimum(Boolean exclusiveMinimum)`
`Schema`	`extensions(Map<String,Object> extensions)`
`Schema`	`externalDocs(ExternalDocumentation externalDocs)`
`Schema`	`format(String format)`
`String`	`get$ref()` returns the $ref property from a Schema instance.
`Object`	`getAdditionalProperties()` returns the additionalProperties property from a Schema instance.
`T`	`getDefault()` returns the _default property from a StringSchema instance.
`Boolean`	`getDeprecated()` returns the deprecated property from a Schema instance.
`String`	`getDescription()` returns the description property from a Schema instance.
`Discriminator`	`getDiscriminator()` returns the discriminator property from a AllOfSchema instance.
`List<T>`	`getEnum()`
`Object`	`getExample()` returns the example property from a Schema instance.
`boolean`	`getExampleSetFlag()` returns true if example setter has been invoked Used to flag explicit setting to null of example (vs missing field) while deserializing from json/yaml string
`Boolean`	`getExclusiveMaximum()` returns the exclusiveMaximum property from a Schema instance.
`Boolean`	`getExclusiveMinimum()` returns the exclusiveMinimum property from a Schema instance.
`Map<String,Object>`	`getExtensions()`
`ExternalDocumentation`	`getExternalDocs()` returns the externalDocs property from a Schema instance.
`String`	`getFormat()` returns the format property from a Schema instance.
`BigDecimal`	`getMaximum()` returns the maximum property from a Schema instance.
`Integer`	`getMaxItems()` returns the maxItems property from a Schema instance.
`Integer`	`getMaxLength()` returns the maxLength property from a Schema instance.
`Integer`	`getMaxProperties()` returns the maxProperties property from a Schema instance.
`BigDecimal`	`getMinimum()` returns the minimum property from a Schema instance.
`Integer`	`getMinItems()` returns the minItems property from a Schema instance.
`Integer`	`getMinLength()` returns the minLength property from a Schema instance.
`Integer`	`getMinProperties()` returns the minProperties property from a Schema instance.
`BigDecimal`	`getMultipleOf()` returns the multipleOf property from a Schema instance.
`String`	`getName()` returns the name property from a from a Schema instance.
`Schema`	`getNot()` returns the not property from a Schema instance.
`Boolean`	`getNullable()` returns the nullable property from a Schema instance.
`String`	`getPattern()` returns the pattern property from a Schema instance.
`Map<String,Schema>`	`getProperties()` returns the properties property from a Schema instance.
`Boolean`	`getReadOnly()` returns the readOnly property from a Schema instance.
`List<String>`	`getRequired()` returns the required property from a Schema instance.
`String`	`getTitle()` returns the title property from a Schema instance.
`String`	`getType()` returns the type property from a Schema instance.
`Boolean`	`getUniqueItems()` returns the uniqueItems property from a Schema instance.
`Boolean`	`getWriteOnly()` returns the writeOnly property from a Schema instance.
`XML`	`getXml()` returns the xml property from a Schema instance.
`int`	`hashCode()`
`Schema`	`maximum(BigDecimal maximum)`
`Schema`	`maxItems(Integer maxItems)`
`Schema`	`maxLength(Integer maxLength)`
`Schema`	`maxProperties(Integer maxProperties)`
`Schema`	`minimum(BigDecimal minimum)`
`Schema`	`minItems(Integer minItems)`
`Schema`	`minLength(Integer minLength)`
`Schema`	`minProperties(Integer minProperties)`
`Schema`	`multipleOf(BigDecimal multipleOf)`
`Schema`	`name(String name)`
`Schema`	`not(Schema not)`
`Schema`	`nullable(Boolean nullable)`
`Schema`	`pattern(String pattern)`
`Schema`	`properties(Map<String,Schema> properties)`
`Schema`	`readOnly(Boolean readOnly)`
`Schema`	`required(List<String> required)`
`void`	`set$ref(String $ref)`
`void`	`setAdditionalProperties(Object additionalProperties)`
`void`	`setDefault(Object _default)`
`void`	`setDeprecated(Boolean deprecated)`
`void`	`setDescription(String description)`
`void`	`setDiscriminator(Discriminator discriminator)`
`void`	`setEnum(List<T> _enum)`
`void`	`setExample(Object example)`
`void`	`setExampleSetFlag(boolean exampleSetFlag)`
`void`	`setExclusiveMaximum(Boolean exclusiveMaximum)`
`void`	`setExclusiveMinimum(Boolean exclusiveMinimum)`
`void`	`setExtensions(Map<String,Object> extensions)`
`void`	`setExternalDocs(ExternalDocumentation externalDocs)`
`void`	`setFormat(String format)`
`void`	`setMaximum(BigDecimal maximum)`
`void`	`setMaxItems(Integer maxItems)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMaxProperties(Integer maxProperties)`
`void`	`setMinimum(BigDecimal minimum)`
`void`	`setMinItems(Integer minItems)`
`void`	`setMinLength(Integer minLength)`
`void`	`setMinProperties(Integer minProperties)`
`void`	`setMultipleOf(BigDecimal multipleOf)`
`void`	`setName(String name)`
`void`	`setNot(Schema not)`
`void`	`setNullable(Boolean nullable)`
`void`	`setPattern(String pattern)`
`void`	`setProperties(Map<String,Schema> properties)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRequired(List<String> required)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`
`void`	`setUniqueItems(Boolean uniqueItems)`
`void`	`setWriteOnly(Boolean writeOnly)`
`void`	`setXml(XML xml)`
`Schema`	`title(String title)`
`protected String`	`toIndentedString(Object o)` Convert the given object to string with each line indented by 4 spaces (except the first line).
`String`	`toString()`
`Schema`	`type(String type)`
`Schema`	`uniqueItems(Boolean uniqueItems)`
`Schema`	`writeOnly(Boolean writeOnly)`
`Schema`	`xml(XML xml)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_default
```
protected T _default
```

example
```
protected T example
```

_enum
```
protected List<T> _enum
```

Constructor Detail

Schema
```
public Schema()
```

Schema

protected Schema(String type,
                 String format)

Method Detail

getName
```
public String getName()
```
returns the name property from a from a Schema instance. Ignored in serialization.

Returns:

String name

setName
```
public void setName(String name)
```

name
```
public Schema name(String name)
```

getDiscriminator
```
public Discriminator getDiscriminator()
```
returns the discriminator property from a AllOfSchema instance.

Returns:

Discriminator discriminator

setDiscriminator

public void setDiscriminator(Discriminator discriminator)

discriminator

public Schema discriminator(Discriminator discriminator)

getTitle
```
public String getTitle()
```
returns the title property from a Schema instance.

Returns:

String title

setTitle
```
public void setTitle(String title)
```

title
```
public Schema title(String title)
```

getDefault
```
public T getDefault()
```
returns the _default property from a StringSchema instance.

Returns:

String _default

setDefault

public void setDefault(Object _default)

cast
```
protected T cast(Object value)
```

getEnum
```
public List<T> getEnum()
```

setEnum
```
public void setEnum(List<T> _enum)
```

addEnumItemObject

public void addEnumItemObject(T _enumItem)

getMultipleOf
```
public BigDecimal getMultipleOf()
```
returns the multipleOf property from a Schema instance.
minimum: 0

Returns:

BigDecimal multipleOf

setMultipleOf

public void setMultipleOf(BigDecimal multipleOf)

multipleOf

public Schema multipleOf(BigDecimal multipleOf)

getMaximum
```
public BigDecimal getMaximum()
```
returns the maximum property from a Schema instance.

Returns:

BigDecimal maximum

setMaximum

public void setMaximum(BigDecimal maximum)

maximum

public Schema maximum(BigDecimal maximum)

getExclusiveMaximum
```
public Boolean getExclusiveMaximum()
```
returns the exclusiveMaximum property from a Schema instance.

Returns:

Boolean exclusiveMaximum

setExclusiveMaximum

public void setExclusiveMaximum(Boolean exclusiveMaximum)

exclusiveMaximum

public Schema exclusiveMaximum(Boolean exclusiveMaximum)

getMinimum
```
public BigDecimal getMinimum()
```
returns the minimum property from a Schema instance.

Returns:

BigDecimal minimum

setMinimum

public void setMinimum(BigDecimal minimum)

minimum

public Schema minimum(BigDecimal minimum)

getExclusiveMinimum
```
public Boolean getExclusiveMinimum()
```
returns the exclusiveMinimum property from a Schema instance.

Returns:

Boolean exclusiveMinimum

setExclusiveMinimum

public void setExclusiveMinimum(Boolean exclusiveMinimum)

exclusiveMinimum

public Schema exclusiveMinimum(Boolean exclusiveMinimum)

getMaxLength
```
public Integer getMaxLength()
```
returns the maxLength property from a Schema instance.
minimum: 0

Returns:

Integer maxLength

setMaxLength

public void setMaxLength(Integer maxLength)

maxLength

public Schema maxLength(Integer maxLength)

getMinLength
```
public Integer getMinLength()
```
returns the minLength property from a Schema instance.
minimum: 0

Returns:

Integer minLength

setMinLength

public void setMinLength(Integer minLength)

minLength

public Schema minLength(Integer minLength)

getPattern
```
public String getPattern()
```
returns the pattern property from a Schema instance.

Returns:

String pattern

setPattern

public void setPattern(String pattern)

pattern

public Schema pattern(String pattern)

getMaxItems
```
public Integer getMaxItems()
```
returns the maxItems property from a Schema instance.
minimum: 0

Returns:

Integer maxItems

setMaxItems

public void setMaxItems(Integer maxItems)

maxItems

public Schema maxItems(Integer maxItems)

getMinItems
```
public Integer getMinItems()
```
returns the minItems property from a Schema instance.
minimum: 0

Returns:

Integer minItems

setMinItems

public void setMinItems(Integer minItems)

minItems

public Schema minItems(Integer minItems)

getUniqueItems
```
public Boolean getUniqueItems()
```
returns the uniqueItems property from a Schema instance.

Returns:

Boolean uniqueItems

setUniqueItems

public void setUniqueItems(Boolean uniqueItems)

uniqueItems

public Schema uniqueItems(Boolean uniqueItems)

getMaxProperties
```
public Integer getMaxProperties()
```
returns the maxProperties property from a Schema instance.
minimum: 0

Returns:

Integer maxProperties

setMaxProperties

public void setMaxProperties(Integer maxProperties)

maxProperties

public Schema maxProperties(Integer maxProperties)

getMinProperties
```
public Integer getMinProperties()
```
returns the minProperties property from a Schema instance.
minimum: 0

Returns:

Integer minProperties

setMinProperties

public void setMinProperties(Integer minProperties)

minProperties

public Schema minProperties(Integer minProperties)

getRequired
```
public List<String> getRequired()
```
returns the required property from a Schema instance.

Returns:

List<String> required

setRequired

public void setRequired(List<String> required)

required

public Schema required(List<String> required)

addRequiredItem

public Schema addRequiredItem(String requiredItem)

getType
```
public String getType()
```
returns the type property from a Schema instance.

Returns:

String type

setType
```
public void setType(String type)
```

type
```
public Schema type(String type)
```

getNot
```
public Schema getNot()
```
returns the not property from a Schema instance.

Returns:

Schema not

setNot
```
public void setNot(Schema not)
```

not
```
public Schema not(Schema not)
```

getProperties
```
public Map<String,Schema> getProperties()
```
returns the properties property from a Schema instance.

Returns:

Map<String, Schema> properties

setProperties

public void setProperties(Map<String,Schema> properties)

properties

public Schema properties(Map<String,Schema> properties)

addProperties

public Schema addProperties(String key,
                            Schema propertiesItem)

getAdditionalProperties
```
public Object getAdditionalProperties()
```
returns the additionalProperties property from a Schema instance. Can be either a Boolean or a Schema

Returns:

Object additionalProperties

setAdditionalProperties

public void setAdditionalProperties(Object additionalProperties)

additionalProperties

public Schema additionalProperties(Object additionalProperties)

getDescription
```
public String getDescription()
```
returns the description property from a Schema instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Schema description(String description)

getFormat
```
public String getFormat()
```
returns the format property from a Schema instance.

Returns:

String format

setFormat
```
public void setFormat(String format)
```

format
```
public Schema format(String format)
```

get$ref
```
public String get$ref()
```
returns the $ref property from a Schema instance.

Returns:

String $ref

set$ref
```
public void set$ref(String $ref)
```

$ref
```
public Schema $ref(String $ref)
```

getNullable
```
public Boolean getNullable()
```
returns the nullable property from a Schema instance.

Returns:

Boolean nullable

setNullable

public void setNullable(Boolean nullable)

nullable

public Schema nullable(Boolean nullable)

getReadOnly
```
public Boolean getReadOnly()
```
returns the readOnly property from a Schema instance.

Returns:

Boolean readOnly

setReadOnly

public void setReadOnly(Boolean readOnly)

readOnly

public Schema readOnly(Boolean readOnly)

getWriteOnly
```
public Boolean getWriteOnly()
```
returns the writeOnly property from a Schema instance.

Returns:

Boolean writeOnly

setWriteOnly

public void setWriteOnly(Boolean writeOnly)

writeOnly

public Schema writeOnly(Boolean writeOnly)

getExample
```
public Object getExample()
```
returns the example property from a Schema instance.

Returns:

String example

setExample

public void setExample(Object example)

example

public Schema example(Object example)

getExternalDocs
```
public ExternalDocumentation getExternalDocs()
```
returns the externalDocs property from a Schema instance.

Returns:

ExternalDocumentation externalDocs

setExternalDocs

public void setExternalDocs(ExternalDocumentation externalDocs)

externalDocs

public Schema externalDocs(ExternalDocumentation externalDocs)

getDeprecated
```
public Boolean getDeprecated()
```
returns the deprecated property from a Schema instance.

Returns:

Boolean deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

deprecated

public Schema deprecated(Boolean deprecated)

getXml
```
public XML getXml()
```
returns the xml property from a Schema instance.

Returns:

XML xml

setXml
```
public void setXml(XML xml)
```

xml
```
public Schema xml(XML xml)
```

getExampleSetFlag
```
public boolean getExampleSetFlag()
```
returns true if example setter has been invoked Used to flag explicit setting to null of example (vs missing field) while deserializing from json/yaml string

Returns:

boolean exampleSetFlag

setExampleSetFlag

public void setExampleSetFlag(boolean exampleSetFlag)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public Schema extensions(Map<String,Object> extensions)

toString
```
public String toString()
```
Overrides:

toString in class Object

toIndentedString
```
protected String toIndentedString(Object o)
```
Convert the given object to string with each line indented by 4 spaces (except the first line).

Class Schema<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_default

example

_enum

Constructor Detail

Schema

Schema

Method Detail

getName

setName

name

getDiscriminator

setDiscriminator

discriminator

getTitle

setTitle

title

getDefault

setDefault

cast

getEnum

setEnum

addEnumItemObject

getMultipleOf

setMultipleOf

multipleOf

getMaximum

setMaximum

maximum

getExclusiveMaximum

setExclusiveMaximum

exclusiveMaximum

getMinimum

setMinimum

minimum

getExclusiveMinimum

setExclusiveMinimum

exclusiveMinimum

getMaxLength

setMaxLength

maxLength

getMinLength

setMinLength

minLength

getPattern

setPattern

pattern

getMaxItems

setMaxItems

maxItems

getMinItems

setMinItems

minItems

getUniqueItems

setUniqueItems

uniqueItems

getMaxProperties

setMaxProperties

maxProperties

getMinProperties

setMinProperties

minProperties

getRequired

setRequired

required

addRequiredItem

getType

setType

type

getNot

setNot

not

getProperties

setProperties

properties