SwaggerSchema Class
- java.
lang. Object - com.
azure. resourcemanager. logic. models. SwaggerSchema
- com.
public final class SwaggerSchema
The swagger schema.
Constructor Summary
Constructor | Description |
---|---|
SwaggerSchema() |
Creates an instance of Swagger |
Method Summary
Modifier and Type | Method and Description |
---|---|
Object |
additionalProperties()
Get the additional |
List<Swagger |
allOf()
Get the all |
String |
discriminator()
Get the discriminator property: The discriminator. |
Swagger |
dynamicListNew()
Get the dynamic |
Swagger |
dynamicSchemaNew()
Get the dynamic |
Swagger |
dynamicSchemaOld()
Get the dynamic |
Swagger |
dynamicTree()
Get the dynamic |
Object |
example()
Get the example property: The example value. |
Swagger |
externalDocs()
Get the external |
Swagger |
items()
Get the items property: The items schema. |
Integer |
maxProperties()
Get the max |
Integer |
minProperties()
Get the min |
Boolean |
notificationUrlExtension()
Get the notification |
Map<String,Swagger |
properties()
Get the properties property: The object properties. |
Boolean |
readOnly()
Get the read |
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. |
Swagger |
type()
Get the type property: The type. |
void |
validate()
Validates the instance. |
Swagger |
withAdditionalProperties(Object additionalProperties)
Set the additional |
Swagger |
withAllOf(List<SwaggerSchema> allOf)
Set the all |
Swagger |
withDiscriminator(String discriminator)
Set the discriminator property: The discriminator. |
Swagger |
withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)
Set the dynamic |
Swagger |
withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)
Set the dynamic |
Swagger |
withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)
Set the dynamic |
Swagger |
withDynamicTree(SwaggerCustomDynamicTree dynamicTree)
Set the dynamic |
Swagger |
withExample(Object example)
Set the example property: The example value. |
Swagger |
withExternalDocs(SwaggerExternalDocumentation externalDocs)
Set the external |
Swagger |
withItems(SwaggerSchema items)
Set the items property: The items schema. |
Swagger |
withMaxProperties(Integer maxProperties)
Set the max |
Swagger |
withMinProperties(Integer minProperties)
Set the min |
Swagger |
withNotificationUrlExtension(Boolean notificationUrlExtension)
Set the notification |
Swagger |
withProperties(Map<String,SwaggerSchema> properties)
Set the properties property: The object properties. |
Swagger |
withReadOnly(Boolean readOnly)
Set the read |
Swagger |
withRef(String ref)
Set the ref property: The reference. |
Swagger |
withRequired(List<String> required)
Set the required property: The object required properties. |
Swagger |
withTitle(String title)
Set the title property: The title. |
Swagger |
withType(SwaggerSchemaType type)
Set the type property: The type. |
Swagger |
withXml(SwaggerXml xml)
Set the xml property: The xml representation format for a property. |
Swagger |
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:
allOf
public List
Get the allOf property: The schemas which must pass validation when this schema is used.
Returns:
discriminator
public String discriminator()
Get the discriminator property: The discriminator.
Returns:
dynamicListNew
public SwaggerCustomDynamicList dynamicListNew()
Get the dynamicListNew property: The dynamic list.
Returns:
dynamicSchemaNew
public SwaggerCustomDynamicProperties dynamicSchemaNew()
Get the dynamicSchemaNew property: The dynamic schema configuration.
Returns:
dynamicSchemaOld
public SwaggerCustomDynamicSchema dynamicSchemaOld()
Get the dynamicSchemaOld property: The dynamic schema configuration.
Returns:
dynamicTree
public SwaggerCustomDynamicTree dynamicTree()
Get the dynamicTree property: The dynamic values tree configuration.
Returns:
example
public Object example()
Get the example property: The example value.
Returns:
externalDocs
public SwaggerExternalDocumentation externalDocs()
Get the externalDocs property: The external documentation.
Returns:
items
public SwaggerSchema items()
Get the items property: The items schema.
Returns:
maxProperties
public Integer maxProperties()
Get the maxProperties property: The maximum number of allowed properties.
Returns:
minProperties
public Integer minProperties()
Get the minProperties property: The minimum number of allowed properties.
Returns:
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:
properties
public Map
Get the properties property: The object properties.
Returns:
readOnly
public Boolean readOnly()
Get the readOnly property: Indicates whether this property must be present in the a request.
Returns:
ref
public String ref()
Get the ref property: The reference.
Returns:
required
public List
Get the required property: The object required properties.
Returns:
title
public String title()
Get the title property: The title.
Returns:
type
public SwaggerSchemaType type()
Get the type property: The type.
Returns:
validate
public void validate()
Validates the instance.
withAdditionalProperties
public SwaggerSchema withAdditionalProperties(Object additionalProperties)
Set the additionalProperties property: The additional properties.
Parameters:
Returns:
withAllOf
public SwaggerSchema withAllOf(List
Set the allOf property: The schemas which must pass validation when this schema is used.
Parameters:
Returns:
withDiscriminator
public SwaggerSchema withDiscriminator(String discriminator)
Set the discriminator property: The discriminator.
Parameters:
Returns:
withDynamicListNew
public SwaggerSchema withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)
Set the dynamicListNew property: The dynamic list.
Parameters:
Returns:
withDynamicSchemaNew
public SwaggerSchema withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)
Set the dynamicSchemaNew property: The dynamic schema configuration.
Parameters:
Returns:
withDynamicSchemaOld
public SwaggerSchema withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)
Set the dynamicSchemaOld property: The dynamic schema configuration.
Parameters:
Returns:
withDynamicTree
public SwaggerSchema withDynamicTree(SwaggerCustomDynamicTree dynamicTree)
Set the dynamicTree property: The dynamic values tree configuration.
Parameters:
Returns:
withExample
public SwaggerSchema withExample(Object example)
Set the example property: The example value.
Parameters:
Returns:
withExternalDocs
public SwaggerSchema withExternalDocs(SwaggerExternalDocumentation externalDocs)
Set the externalDocs property: The external documentation.
Parameters:
Returns:
withItems
public SwaggerSchema withItems(SwaggerSchema items)
Set the items property: The items schema.
Parameters:
Returns:
withMaxProperties
public SwaggerSchema withMaxProperties(Integer maxProperties)
Set the maxProperties property: The maximum number of allowed properties.
Parameters:
Returns:
withMinProperties
public SwaggerSchema withMinProperties(Integer minProperties)
Set the minProperties property: The minimum number of allowed properties.
Parameters:
Returns:
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:
Returns:
withProperties
public SwaggerSchema withProperties(Map
Set the properties property: The object properties.
Parameters:
Returns:
withReadOnly
public SwaggerSchema withReadOnly(Boolean readOnly)
Set the readOnly property: Indicates whether this property must be present in the a request.
Parameters:
Returns:
withRef
public SwaggerSchema withRef(String ref)
Set the ref property: The reference.
Parameters:
Returns:
withRequired
public SwaggerSchema withRequired(List
Set the required property: The object required properties.
Parameters:
Returns:
withTitle
public SwaggerSchema withTitle(String title)
Set the title property: The title.
Parameters:
Returns:
withType
public SwaggerSchema withType(SwaggerSchemaType type)
Set the type property: The type.
Parameters:
Returns:
withXml
public SwaggerSchema withXml(SwaggerXml xml)
Set the xml property: The xml representation format for a property.
Parameters:
Returns:
xml
public SwaggerXml xml()
Get the xml property: The xml representation format for a property.
Returns:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for