Package com.azure.resourcemanager.apimanagement.models

Class ApiVersionSetEntityBase

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiVersionSetEntityBase
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiVersionSetEntityBase>
Direct Known Subclasses:
ApiVersionSetContractProperties, ApiVersionSetUpdateParametersProperties
public class ApiVersionSetEntityBase extends Object implements com.azure.json.JsonSerializable<ApiVersionSetEntityBase>
API Version set base parameters.

  • Constructor Details

    • ApiVersionSetEntityBase

      public ApiVersionSetEntityBase()
      Creates an instance of ApiVersionSetEntityBase class.

  • Method Details

    • description

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

    • withDescription

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

    • fromJson

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