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

Class ApiContractInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.fluent.models.ApiContractInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class ApiContractInner extends com.azure.core.management.ProxyResource
API details.

  • Constructor Details

    • ApiContractInner

      public ApiContractInner()
      Creates an instance of ApiContractInner class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • sourceApiId

      public String sourceApiId()
      Get the sourceApiId property: API identifier of the source API.
      Returns:
      the sourceApiId value.

    • withSourceApiId

      public ApiContractInner withSourceApiId(String sourceApiId)
      Set the sourceApiId property: API identifier of the source API.
      Parameters:
      sourceApiId - the sourceApiId value to set.
      Returns:
      the ApiContractInner object itself.

    • displayName

      public String displayName()
      Get the displayName property: API name. Must be 1 to 300 characters long.
      Returns:
      the displayName value.

    • withDisplayName

      public ApiContractInner withDisplayName(String displayName)
      Set the displayName property: API name. Must be 1 to 300 characters long.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ApiContractInner object itself.

    • serviceUrl

      public String serviceUrl()
      Get the serviceUrl property: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
      Returns:
      the serviceUrl value.

    • withServiceUrl

      public ApiContractInner withServiceUrl(String serviceUrl)
      Set the serviceUrl property: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
      Parameters:
      serviceUrl - the serviceUrl value to set.
      Returns:
      the ApiContractInner object itself.

    • path

      public String path()
      Get the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
      Returns:
      the path value.

    • withPath

      public ApiContractInner withPath(String path)
      Set the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
      Parameters:
      path - the path value to set.
      Returns:
      the ApiContractInner object itself.

    • protocols

      public List<Protocol> protocols()
      Get the protocols property: Describes on which protocols the operations in this API can be invoked.
      Returns:
      the protocols value.

    • withProtocols

      public ApiContractInner withProtocols(List<Protocol> protocols)
      Set the protocols property: Describes on which protocols the operations in this API can be invoked.
      Parameters:
      protocols - the protocols value to set.
      Returns:
      the ApiContractInner object itself.

    • apiVersionSet

      public ApiVersionSetContractDetails apiVersionSet()
      Get the apiVersionSet property: Version set details.
      Returns:
      the apiVersionSet value.

    • withApiVersionSet

      public ApiContractInner withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)
      Set the apiVersionSet property: Version set details.
      Parameters:
      apiVersionSet - the apiVersionSet value to set.
      Returns:
      the ApiContractInner object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The provisioning state.
      Returns:
      the provisioningState value.

    • description

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

    • withDescription

      public ApiContractInner 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 ApiContractInner object itself.

    • authenticationSettings

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

    • withAuthenticationSettings

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

    • subscriptionKeyParameterNames

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

    • withSubscriptionKeyParameterNames

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

    • apiType

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

    • withApiType

      public ApiContractInner withApiType(ApiType apiType)
      Set the apiType property: Type of API.
      Parameters:
      apiType - the apiType value to set.
      Returns:
      the ApiContractInner 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 ApiContractInner 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 ApiContractInner 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 ApiContractInner 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 ApiContractInner object itself.

    • isCurrent

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

    • withIsCurrent

      public ApiContractInner withIsCurrent(Boolean isCurrent)
      Set the isCurrent property: Indicates if API revision is current api revision.
      Parameters:
      isCurrent - the isCurrent value to set.
      Returns:
      the ApiContractInner 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 ApiContractInner withApiRevisionDescription(String apiRevisionDescription)
      Set the apiRevisionDescription property: Description of the API Revision.
      Parameters:
      apiRevisionDescription - the apiRevisionDescription value to set.
      Returns:
      the ApiContractInner object itself.

    • apiVersionDescription

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

    • withApiVersionDescription

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

    • apiVersionSetId

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

    • withApiVersionSetId

      public ApiContractInner withApiVersionSetId(String apiVersionSetId)
      Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
      Parameters:
      apiVersionSetId - the apiVersionSetId value to set.
      Returns:
      the ApiContractInner 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 ApiContractInner 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 ApiContractInner 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 ApiContractInner 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 ApiContractInner object itself.

    • contact

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

    • withContact

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

    • license

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

    • withLicense

      public ApiContractInner withLicense(ApiLicenseInformation license)
      Set the license property: License information for the API.
      Parameters:
      license - the license value to set.
      Returns:
      the ApiContractInner 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.ProxyResource
      Throws:
      IOException

    • fromJson

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