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

Class ApiVersionSetContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiVersionSetEntityBase
com.azure.resourcemanager.apimanagement.fluent.models.ApiVersionSetContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiVersionSetEntityBase>
public final class ApiVersionSetContractProperties extends ApiVersionSetEntityBase
Properties of an API Version Set.

  • Constructor Details

    • ApiVersionSetContractProperties

      public ApiVersionSetContractProperties()
      Creates an instance of ApiVersionSetContractProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: Name of API Version Set.
      Returns:
      the displayName value.

    • withDisplayName

      public ApiVersionSetContractProperties withDisplayName(String displayName)
      Set the displayName property: Name of API Version Set.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ApiVersionSetContractProperties object itself.

    • versioningScheme

      public VersioningScheme versioningScheme()
      Get the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.
      Returns:
      the versioningScheme value.

    • withVersioningScheme

      public ApiVersionSetContractProperties withVersioningScheme(VersioningScheme versioningScheme)
      Set the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.
      Parameters:
      versioningScheme - the versioningScheme value to set.
      Returns:
      the ApiVersionSetContractProperties object itself.

    • withDescription

      public ApiVersionSetContractProperties withDescription(String description)
      Set the description property: Description of API Version Set.
      Overrides:
      withDescription in class ApiVersionSetEntityBase
      Parameters:
      description - the description value to set.
      Returns:
      the ApiVersionSetEntityBase object itself.

    • withVersionQueryName

      public ApiVersionSetContractProperties withVersionQueryName(String versionQueryName)
      Set the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
      Overrides:
      withVersionQueryName in class ApiVersionSetEntityBase
      Parameters:
      versionQueryName - the versionQueryName value to set.
      Returns:
      the ApiVersionSetEntityBase object itself.

    • withVersionHeaderName

      public ApiVersionSetContractProperties withVersionHeaderName(String versionHeaderName)
      Set the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
      Overrides:
      withVersionHeaderName in class ApiVersionSetEntityBase
      Parameters:
      versionHeaderName - the versionHeaderName value to set.
      Returns:
      the ApiVersionSetEntityBase object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ApiVersionSetEntityBase
      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<ApiVersionSetEntityBase>
      Overrides:
      toJson in class ApiVersionSetEntityBase
      Throws:
      IOException

    • fromJson

      public static ApiVersionSetContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiVersionSetContractProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiVersionSetContractProperties 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 ApiVersionSetContractProperties.