Package com.azure.resourcemanager.apimanagement.models

Class ApiEntityBaseContract

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiEntityBaseContract>
Direct Known Subclasses:
ApiContractProperties, ApiContractUpdateProperties, ApiTagResourceContractProperties
public class ApiEntityBaseContract extends Object implements com.azure.json.JsonSerializable<ApiEntityBaseContract>
API base contract details.

  • Constructor Details

    • ApiEntityBaseContract

      public ApiEntityBaseContract()
      Creates an instance of ApiEntityBaseContract class.

  • Method Details

    • description

      public String description()
      Get the description property: Description of the API. May include HTML formatting tags.
      Returns:
      the description value.

    • withDescription

      public ApiEntityBaseContract withDescription(String description)
      Set the description property: Description of the API. May include HTML formatting tags.
      Parameters:
      description - the description value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • authenticationSettings

      public AuthenticationSettingsContract authenticationSettings()
      Get the authenticationSettings property: Collection of authentication settings included into this API.
      Returns:
      the authenticationSettings value.

    • withAuthenticationSettings

      public ApiEntityBaseContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)
      Set the authenticationSettings property: Collection of authentication settings included into this API.
      Parameters:
      authenticationSettings - the authenticationSettings value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • subscriptionKeyParameterNames

      public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()
      Get the subscriptionKeyParameterNames property: Protocols over which API is made available.
      Returns:
      the subscriptionKeyParameterNames value.

    • withSubscriptionKeyParameterNames

      public ApiEntityBaseContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)
      Set the subscriptionKeyParameterNames property: Protocols over which API is made available.
      Parameters:
      subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • apiType

      public ApiType apiType()
      Get the apiType property: Type of API.
      Returns:
      the apiType value.

    • withApiType

      public ApiEntityBaseContract withApiType(ApiType apiType)
      Set the apiType property: Type of API.
      Parameters:
      apiType - the apiType value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • apiRevision

      public String apiRevision()
      Get the apiRevision property: Describes the revision of the API. If no value is provided, default revision 1 is created.
      Returns:
      the apiRevision value.

    • withApiRevision

      public ApiEntityBaseContract withApiRevision(String apiRevision)
      Set the apiRevision property: Describes the revision of the API. If no value is provided, default revision 1 is created.
      Parameters:
      apiRevision - the apiRevision value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • apiVersion

      public String apiVersion()
      Get the apiVersion property: Indicates the version identifier of the API if the API is versioned.
      Returns:
      the apiVersion value.

    • withApiVersion

      public ApiEntityBaseContract withApiVersion(String apiVersion)
      Set the apiVersion property: Indicates the version identifier of the API if the API is versioned.
      Parameters:
      apiVersion - the apiVersion value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • isCurrent

      public Boolean isCurrent()
      Get the isCurrent property: Indicates if API revision is current api revision.
      Returns:
      the isCurrent value.

    • withIsCurrent

      public ApiEntityBaseContract withIsCurrent(Boolean isCurrent)
      Set the isCurrent property: Indicates if API revision is current api revision.
      Parameters:
      isCurrent - the isCurrent value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • isOnline

      public Boolean isOnline()
      Get the isOnline property: Indicates if API revision is accessible via the gateway.
      Returns:
      the isOnline value.

    • apiRevisionDescription

      public String apiRevisionDescription()
      Get the apiRevisionDescription property: Description of the API Revision.
      Returns:
      the apiRevisionDescription value.

    • withApiRevisionDescription

      public ApiEntityBaseContract withApiRevisionDescription(String apiRevisionDescription)
      Set the apiRevisionDescription property: Description of the API Revision.
      Parameters:
      apiRevisionDescription - the apiRevisionDescription value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • apiVersionDescription

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

    • withApiVersionDescription

      public ApiEntityBaseContract withApiVersionDescription(String apiVersionDescription)
      Set the apiVersionDescription property: Description of the API Version.
      Parameters:
      apiVersionDescription - the apiVersionDescription value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • apiVersionSetId

      public String apiVersionSetId()
      Get the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
      Returns:
      the apiVersionSetId value.

    • withApiVersionSetId

      public ApiEntityBaseContract withApiVersionSetId(String apiVersionSetId)
      Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
      Parameters:
      apiVersionSetId - the apiVersionSetId value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • subscriptionRequired

      public Boolean subscriptionRequired()
      Get the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
      Returns:
      the subscriptionRequired value.

    • withSubscriptionRequired

      public ApiEntityBaseContract withSubscriptionRequired(Boolean subscriptionRequired)
      Set the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
      Parameters:
      subscriptionRequired - the subscriptionRequired value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • termsOfServiceUrl

      public String termsOfServiceUrl()
      Get the termsOfServiceUrl property: A URL to the Terms of Service for the API. MUST be in the format of a URL.
      Returns:
      the termsOfServiceUrl value.

    • withTermsOfServiceUrl

      public ApiEntityBaseContract withTermsOfServiceUrl(String termsOfServiceUrl)
      Set the termsOfServiceUrl property: A URL to the Terms of Service for the API. MUST be in the format of a URL.
      Parameters:
      termsOfServiceUrl - the termsOfServiceUrl value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • contact

      public ApiContactInformation contact()
      Get the contact property: Contact information for the API.
      Returns:
      the contact value.

    • withContact

      public ApiEntityBaseContract withContact(ApiContactInformation contact)
      Set the contact property: Contact information for the API.
      Parameters:
      contact - the contact value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • license

      public ApiLicenseInformation license()
      Get the license property: License information for the API.
      Returns:
      the license value.

    • withLicense

      public ApiEntityBaseContract withLicense(ApiLicenseInformation license)
      Set the license property: License information for the API.
      Parameters:
      license - the license value to set.
      Returns:
      the ApiEntityBaseContract 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<ApiEntityBaseContract>
      Throws:
      IOException

    • fromJson

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