Package com.azure.resourcemanager.apimanagement.models

Class ApiVersionSetContractDetails

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiVersionSetContractDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiVersionSetContractDetails>
public final class ApiVersionSetContractDetails extends Object implements com.azure.json.JsonSerializable<ApiVersionSetContractDetails>
An API Version Set contains the common configuration for a set of API Versions relating.

  • Constructor Details

    • ApiVersionSetContractDetails

      public ApiVersionSetContractDetails()
      Creates an instance of ApiVersionSetContractDetails class.

  • Method Details

    • id

      public String id()
      Get the id property: Identifier for existing API Version Set. Omit this value to create a new Version Set.
      Returns:
      the id value.

    • withId

      public ApiVersionSetContractDetails withId(String id)
      Set the id property: Identifier for existing API Version Set. Omit this value to create a new Version Set.
      Parameters:
      id - the id value to set.
      Returns:
      the ApiVersionSetContractDetails object itself.

    • name

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

    • withName

      public ApiVersionSetContractDetails withName(String name)
      Set the name property: The display Name of the API Version Set.
      Parameters:
      name - the name value to set.
      Returns:
      the ApiVersionSetContractDetails object itself.

    • description

      public String description()
      Get the description property: Description of API Version Set.
      Returns:
      the description value.

    • withDescription

      public ApiVersionSetContractDetails withDescription(String description)
      Set the description property: Description of API Version Set.
      Parameters:
      description - the description value to set.
      Returns:
      the ApiVersionSetContractDetails 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 ApiVersionSetContractDetails 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 ApiVersionSetContractDetails object itself.

    • versionQueryName

      public String versionQueryName()
      Get the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
      Returns:
      the versionQueryName value.

    • withVersionQueryName

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

    • versionHeaderName

      public String versionHeaderName()
      Get the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
      Returns:
      the versionHeaderName value.

    • withVersionHeaderName

      public ApiVersionSetContractDetails withVersionHeaderName(String versionHeaderName)
      Set the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
      Parameters:
      versionHeaderName - the versionHeaderName value to set.
      Returns:
      the ApiVersionSetContractDetails 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<ApiVersionSetContractDetails>
      Throws:
      IOException

    • fromJson

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