SwaggerSchema Class

  • java.lang.Object
    • com.azure.resourcemanager.logic.models.SwaggerSchema

public final class SwaggerSchema

The swagger schema.

Constructor Summary

Constructor Description
SwaggerSchema()

Creates an instance of SwaggerSchema class.

Method Summary

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.

Methods inherited from java.lang.Object

Constructor Details

SwaggerSchema

public SwaggerSchema()

Creates an instance of SwaggerSchema class.

Method Details

additionalProperties

public Object additionalProperties()

Get the additionalProperties property: The additional properties.

Returns:

the additionalProperties value.

allOf

public List allOf()

Get the allOf property: The schemas which must pass validation when this schema is used.

Returns:

the allOf value.

discriminator

public String discriminator()

Get the discriminator property: The discriminator.

Returns:

the discriminator value.

dynamicListNew

public SwaggerCustomDynamicList dynamicListNew()

Get the dynamicListNew property: The dynamic list.

Returns:

the dynamicListNew value.

dynamicSchemaNew

public SwaggerCustomDynamicProperties dynamicSchemaNew()

Get the dynamicSchemaNew property: The dynamic schema configuration.

Returns:

the dynamicSchemaNew value.

dynamicSchemaOld

public SwaggerCustomDynamicSchema dynamicSchemaOld()

Get the dynamicSchemaOld property: The dynamic schema configuration.

Returns:

the dynamicSchemaOld value.

dynamicTree

public SwaggerCustomDynamicTree dynamicTree()

Get the dynamicTree property: The dynamic values tree configuration.

Returns:

the dynamicTree value.

example

public Object example()

Get the example property: The example value.

Returns:

the example value.

externalDocs

public SwaggerExternalDocumentation externalDocs()

Get the externalDocs property: The external documentation.

Returns:

the externalDocs value.

items

public SwaggerSchema items()

Get the items property: The items schema.

Returns:

the items value.

maxProperties

public Integer maxProperties()

Get the maxProperties property: The maximum number of allowed properties.

Returns:

the maxProperties value.

minProperties

public Integer minProperties()

Get the minProperties property: The minimum number of allowed properties.

Returns:

the minProperties value.

notificationUrlExtension

public Boolean notificationUrlExtension()

Get the notificationUrlExtension property: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.

Returns:

the notificationUrlExtension value.

properties

public Map properties()

Get the properties property: The object properties.

Returns:

the properties value.

readOnly

public Boolean readOnly()

Get the readOnly property: Indicates whether this property must be present in the a request.

Returns:

the readOnly value.

ref

public String ref()

Get the ref property: The reference.

Returns:

the ref value.

required

public List required()

Get the required property: The object required properties.

Returns:

the required value.

title

public String title()

Get the title property: The title.

Returns:

the title value.

type

public SwaggerSchemaType type()

Get the type property: The type.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAdditionalProperties

public SwaggerSchema withAdditionalProperties(Object additionalProperties)

Set the additionalProperties property: The additional properties.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the SwaggerSchema object itself.

withAllOf

public SwaggerSchema withAllOf(List allOf)

Set the allOf property: The schemas which must pass validation when this schema is used.

Parameters:

allOf - the allOf value to set.

Returns:

the SwaggerSchema object itself.

withDiscriminator

public SwaggerSchema withDiscriminator(String discriminator)

Set the discriminator property: The discriminator.

Parameters:

discriminator - the discriminator value to set.

Returns:

the SwaggerSchema object itself.

withDynamicListNew

public SwaggerSchema withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)

Set the dynamicListNew property: The dynamic list.

Parameters:

dynamicListNew - the dynamicListNew value to set.

Returns:

the SwaggerSchema object itself.

withDynamicSchemaNew

public SwaggerSchema withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)

Set the dynamicSchemaNew property: The dynamic schema configuration.

Parameters:

dynamicSchemaNew - the dynamicSchemaNew value to set.

Returns:

the SwaggerSchema object itself.

withDynamicSchemaOld

public SwaggerSchema withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)

Set the dynamicSchemaOld property: The dynamic schema configuration.

Parameters:

dynamicSchemaOld - the dynamicSchemaOld value to set.

Returns:

the SwaggerSchema object itself.

withDynamicTree

public SwaggerSchema withDynamicTree(SwaggerCustomDynamicTree dynamicTree)

Set the dynamicTree property: The dynamic values tree configuration.

Parameters:

dynamicTree - the dynamicTree value to set.

Returns:

the SwaggerSchema object itself.

withExample

public SwaggerSchema withExample(Object example)

Set the example property: The example value.

Parameters:

example - the example value to set.

Returns:

the SwaggerSchema object itself.

withExternalDocs

public SwaggerSchema withExternalDocs(SwaggerExternalDocumentation externalDocs)

Set the externalDocs property: The external documentation.

Parameters:

externalDocs - the externalDocs value to set.

Returns:

the SwaggerSchema object itself.

withItems

public SwaggerSchema withItems(SwaggerSchema items)

Set the items property: The items schema.

Parameters:

items - the items value to set.

Returns:

the SwaggerSchema object itself.

withMaxProperties

public SwaggerSchema withMaxProperties(Integer maxProperties)

Set the maxProperties property: The maximum number of allowed properties.

Parameters:

maxProperties - the maxProperties value to set.

Returns:

the SwaggerSchema object itself.

withMinProperties

public SwaggerSchema withMinProperties(Integer minProperties)

Set the minProperties property: The minimum number of allowed properties.

Parameters:

minProperties - the minProperties value to set.

Returns:

the SwaggerSchema object itself.

withNotificationUrlExtension

public SwaggerSchema withNotificationUrlExtension(Boolean notificationUrlExtension)

Set the notificationUrlExtension property: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.

Parameters:

notificationUrlExtension - the notificationUrlExtension value to set.

Returns:

the SwaggerSchema object itself.

withProperties

public SwaggerSchema withProperties(Map properties)

Set the properties property: The object properties.

Parameters:

properties - the properties value to set.

Returns:

the SwaggerSchema object itself.

withReadOnly

public SwaggerSchema withReadOnly(Boolean readOnly)

Set the readOnly property: Indicates whether this property must be present in the a request.

Parameters:

readOnly - the readOnly value to set.

Returns:

the SwaggerSchema object itself.

withRef

public SwaggerSchema withRef(String ref)

Set the ref property: The reference.

Parameters:

ref - the ref value to set.

Returns:

the SwaggerSchema object itself.

withRequired

public SwaggerSchema withRequired(List required)

Set the required property: The object required properties.

Parameters:

required - the required value to set.

Returns:

the SwaggerSchema object itself.

withTitle

public SwaggerSchema withTitle(String title)

Set the title property: The title.

Parameters:

title - the title value to set.

Returns:

the SwaggerSchema object itself.

withType

public SwaggerSchema withType(SwaggerSchemaType type)

Set the type property: The type.

Parameters:

type - the type value to set.

Returns:

the SwaggerSchema object itself.

withXml

public SwaggerSchema withXml(SwaggerXml xml)

Set the xml property: The xml representation format for a property.

Parameters:

xml - the xml value to set.

Returns:

the SwaggerSchema object itself.

xml

public SwaggerXml xml()

Get the xml property: The xml representation format for a property.

Returns:

the xml value.

Applies to