Package com.azure.resourcemanager.apimanagement.models

Interface SchemaContract

public interface SchemaContract
An immutable client-side representation of SchemaContract.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • contentType

      String contentType()
      Gets 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.

    • provisioningState

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

    • value

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

    • definitions

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

    • components

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

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      SchemaContractInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.SchemaContractInner object.
      Returns:
      the inner object.

    • update

      SchemaContract.Update update()
      Begins update for the SchemaContract resource.
      Returns:
      the stage of resource update.

    • refresh

      SchemaContract refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      SchemaContract refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.