Package com.azure.resourcemanager.apimanagement.models

Class ConfigurationApi

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ConfigurationApi
All Implemented Interfaces:
com.azure.json.JsonSerializable<ConfigurationApi>
public final class ConfigurationApi extends Object implements com.azure.json.JsonSerializable<ConfigurationApi>
Information regarding the Configuration API of the API Management service.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigurationApi()
    Creates an instance of ConfigurationApi class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConfigurationApi
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ConfigurationApi from the JsonReader.
    LegacyApiState
    legacyApi()
    Get the legacyApi property: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    ConfigurationApi
    withLegacyApi(LegacyApiState legacyApi)
    Set the legacyApi property: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ConfigurationApi

      public ConfigurationApi()
      Creates an instance of ConfigurationApi class.

  • Method Details

    • legacyApi

      public LegacyApiState legacyApi()
      Get the legacyApi property: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'.
      Returns:
      the legacyApi value.

    • withLegacyApi

      public ConfigurationApi withLegacyApi(LegacyApiState legacyApi)
      Set the legacyApi property: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'.
      Parameters:
      legacyApi - the legacyApi value to set.
      Returns:
      the ConfigurationApi 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<ConfigurationApi>
      Throws:
      IOException

    • fromJson

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