Package com.azure.resourcemanager.apimanagement.fluent.models

Class SchemaDocumentProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.fluent.models.SchemaDocumentProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<SchemaDocumentProperties>
public final class SchemaDocumentProperties extends Object implements com.azure.json.JsonSerializable<SchemaDocumentProperties>
Api Schema Document Properties.

  • Constructor Details

    • SchemaDocumentProperties

      public SchemaDocumentProperties()
      Creates an instance of SchemaDocumentProperties class.

  • Method Details

    • value

      public String value()
      Get the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
      Returns:
      the value value.

    • withValue

      public SchemaDocumentProperties withValue(String value)
      Set the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
      Parameters:
      value - the value value to set.
      Returns:
      the SchemaDocumentProperties object itself.

    • definitions

      public Object definitions()
      Get the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
      Returns:
      the definitions value.

    • withDefinitions

      public SchemaDocumentProperties withDefinitions(Object definitions)
      Set the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
      Parameters:
      definitions - the definitions value to set.
      Returns:
      the SchemaDocumentProperties object itself.

    • components

      public Object components()
      Get the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
      Returns:
      the components value.

    • withComponents

      public SchemaDocumentProperties withComponents(Object components)
      Set the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
      Parameters:
      components - the components value to set.
      Returns:
      the SchemaDocumentProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SchemaDocumentProperties>
      Throws:
      IOException

    • fromJson

      public static SchemaDocumentProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SchemaDocumentProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SchemaDocumentProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the SchemaDocumentProperties.