Package com.azure.resourcemanager.apimanagement.models

Interface ApiContract

public interface ApiContract
An immutable client-side representation of ApiContract.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • sourceApiId

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

    • displayName

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

    • serviceUrl

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

    • path

      String path()
      Gets 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.

    • protocols

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

    • apiVersionSet

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

    • provisioningState

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

    • description

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

    • authenticationSettings

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

    • subscriptionKeyParameterNames

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

    • apiType

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

    • apiRevision

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

    • apiVersion

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

    • isCurrent

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

    • isOnline

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

    • apiRevisionDescription

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

    • apiVersionDescription

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

    • apiVersionSetId

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

    • subscriptionRequired

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

    • termsOfServiceUrl

      String termsOfServiceUrl()
      Gets 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.

    • contact

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

    • license

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

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      ApiContractInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiContractInner object.
      Returns:
      the inner object.

    • update

      ApiContract.Update update()
      Begins update for the ApiContract resource.
      Returns:
      the stage of resource update.

    • refresh

      ApiContract refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ApiContract refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.