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

Class SchemaContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.fluent.models.SchemaContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<SchemaContractProperties>
public final class SchemaContractProperties extends Object implements com.azure.json.JsonSerializable<SchemaContractProperties>
API Schema create or update contract Properties.

  • Constructor Details

    • SchemaContractProperties

      public SchemaContractProperties()
      Creates an instance of SchemaContractProperties class.

  • Method Details

    • contentType

      public String contentType()
      Get the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml` </br> - `OData Schema` use `application/vnd.ms-azure-apim.odata.schema` </br> - `gRPC Schema` use `text/protobuf`.
      Returns:
      the contentType value.

    • withContentType

      public SchemaContractProperties withContentType(String contentType)
      Set the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml` </br> - `OData Schema` use `application/vnd.ms-azure-apim.odata.schema` </br> - `gRPC Schema` use `text/protobuf`.
      Parameters:
      contentType - the contentType value to set.
      Returns:
      the SchemaContractProperties object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The provisioning state.
      Returns:
      the provisioningState value.

    • 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 SchemaContractProperties 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 SchemaContractProperties 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 SchemaContractProperties 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 SchemaContractProperties 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 SchemaContractProperties 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 SchemaContractProperties 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<SchemaContractProperties>
      Throws:
      IOException

    • fromJson

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