public final class SwaggerSchema extends Object
Constructor and Description |
---|
SwaggerSchema() |
Modifier and Type | Method and Description |
---|---|
Object |
additionalProperties()
Get the additionalProperties property: The additional properties.
|
List<SwaggerSchema> |
allOf()
Get the allOf property: The schemas which must pass validation when this schema is used.
|
String |
discriminator()
Get the discriminator property: The discriminator.
|
SwaggerCustomDynamicList |
dynamicListNew()
Get the dynamicListNew property: The dynamic list.
|
SwaggerCustomDynamicProperties |
dynamicSchemaNew()
Get the dynamicSchemaNew property: The dynamic schema configuration.
|
SwaggerCustomDynamicSchema |
dynamicSchemaOld()
Get the dynamicSchemaOld property: The dynamic schema configuration.
|
SwaggerCustomDynamicTree |
dynamicTree()
Get the dynamicTree property: The dynamic values tree configuration.
|
Object |
example()
Get the example property: The example value.
|
SwaggerExternalDocumentation |
externalDocs()
Get the externalDocs property: The external documentation.
|
SwaggerSchema |
items()
Get the items property: The items schema.
|
Integer |
maxProperties()
Get the maxProperties property: The maximum number of allowed properties.
|
Integer |
minProperties()
Get the minProperties property: The minimum number of allowed properties.
|
Boolean |
notificationUrlExtension()
Get the notificationUrlExtension property: Indicates the notification url extension.
|
Map<String,SwaggerSchema> |
properties()
Get the properties property: The object properties.
|
Boolean |
readOnly()
Get the readOnly property: Indicates whether this property must be present in the a request.
|
String |
ref()
Get the ref property: The reference.
|
List<String> |
required()
Get the required property: The object required properties.
|
String |
title()
Get the title property: The title.
|
SwaggerSchemaType |
type()
Get the type property: The type.
|
void |
validate()
Validates the instance.
|
SwaggerSchema |
withAdditionalProperties(Object additionalProperties)
Set the additionalProperties property: The additional properties.
|
SwaggerSchema |
withAllOf(List<SwaggerSchema> allOf)
Set the allOf property: The schemas which must pass validation when this schema is used.
|
SwaggerSchema |
withDiscriminator(String discriminator)
Set the discriminator property: The discriminator.
|
SwaggerSchema |
withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)
Set the dynamicListNew property: The dynamic list.
|
SwaggerSchema |
withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)
Set the dynamicSchemaNew property: The dynamic schema configuration.
|
SwaggerSchema |
withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)
Set the dynamicSchemaOld property: The dynamic schema configuration.
|
SwaggerSchema |
withDynamicTree(SwaggerCustomDynamicTree dynamicTree)
Set the dynamicTree property: The dynamic values tree configuration.
|
SwaggerSchema |
withExample(Object example)
Set the example property: The example value.
|
SwaggerSchema |
withExternalDocs(SwaggerExternalDocumentation externalDocs)
Set the externalDocs property: The external documentation.
|
SwaggerSchema |
withItems(SwaggerSchema items)
Set the items property: The items schema.
|
SwaggerSchema |
withMaxProperties(Integer maxProperties)
Set the maxProperties property: The maximum number of allowed properties.
|
SwaggerSchema |
withMinProperties(Integer minProperties)
Set the minProperties property: The minimum number of allowed properties.
|
SwaggerSchema |
withNotificationUrlExtension(Boolean notificationUrlExtension)
Set the notificationUrlExtension property: Indicates the notification url extension.
|
SwaggerSchema |
withProperties(Map<String,SwaggerSchema> properties)
Set the properties property: The object properties.
|
SwaggerSchema |
withReadOnly(Boolean readOnly)
Set the readOnly property: Indicates whether this property must be present in the a request.
|
SwaggerSchema |
withRef(String ref)
Set the ref property: The reference.
|
SwaggerSchema |
withRequired(List<String> required)
Set the required property: The object required properties.
|
SwaggerSchema |
withTitle(String title)
Set the title property: The title.
|
SwaggerSchema |
withType(SwaggerSchemaType type)
Set the type property: The type.
|
SwaggerSchema |
withXml(SwaggerXml xml)
Set the xml property: The xml representation format for a property.
|
SwaggerXml |
xml()
Get the xml property: The xml representation format for a property.
|
public String ref()
public SwaggerSchema withRef(String ref)
ref
- the ref value to set.public SwaggerSchemaType type()
public SwaggerSchema withType(SwaggerSchemaType type)
type
- the type value to set.public String title()
public SwaggerSchema withTitle(String title)
title
- the title value to set.public SwaggerSchema items()
public SwaggerSchema withItems(SwaggerSchema items)
items
- the items value to set.public Map<String,SwaggerSchema> properties()
public SwaggerSchema withProperties(Map<String,SwaggerSchema> properties)
properties
- the properties value to set.public Object additionalProperties()
public SwaggerSchema withAdditionalProperties(Object additionalProperties)
additionalProperties
- the additionalProperties value to set.public List<String> required()
public SwaggerSchema withRequired(List<String> required)
required
- the required value to set.public Integer maxProperties()
public SwaggerSchema withMaxProperties(Integer maxProperties)
maxProperties
- the maxProperties value to set.public Integer minProperties()
public SwaggerSchema withMinProperties(Integer minProperties)
minProperties
- the minProperties value to set.public List<SwaggerSchema> allOf()
public SwaggerSchema withAllOf(List<SwaggerSchema> allOf)
allOf
- the allOf value to set.public String discriminator()
public SwaggerSchema withDiscriminator(String discriminator)
discriminator
- the discriminator value to set.public Boolean readOnly()
public SwaggerSchema withReadOnly(Boolean readOnly)
readOnly
- the readOnly value to set.public SwaggerXml xml()
public SwaggerSchema withXml(SwaggerXml xml)
xml
- the xml value to set.public SwaggerExternalDocumentation externalDocs()
public SwaggerSchema withExternalDocs(SwaggerExternalDocumentation externalDocs)
externalDocs
- the externalDocs value to set.public Object example()
public SwaggerSchema withExample(Object example)
example
- the example value to set.public Boolean notificationUrlExtension()
public SwaggerSchema withNotificationUrlExtension(Boolean notificationUrlExtension)
notificationUrlExtension
- the notificationUrlExtension value to set.public SwaggerCustomDynamicSchema dynamicSchemaOld()
public SwaggerSchema withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)
dynamicSchemaOld
- the dynamicSchemaOld value to set.public SwaggerCustomDynamicProperties dynamicSchemaNew()
public SwaggerSchema withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)
dynamicSchemaNew
- the dynamicSchemaNew value to set.public SwaggerCustomDynamicList dynamicListNew()
public SwaggerSchema withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)
dynamicListNew
- the dynamicListNew value to set.public SwaggerCustomDynamicTree dynamicTree()
public SwaggerSchema withDynamicTree(SwaggerCustomDynamicTree dynamicTree)
dynamicTree
- the dynamicTree value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.