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

Class ApiContractUpdateProperties

  • public final class ApiContractUpdateProperties
extends ApiEntityBaseContract
    API update contract properties.

    • Constructor Detail

      • ApiContractUpdateProperties

        public ApiContractUpdateProperties()

    • Method Detail

      • displayName

        public String displayName()
        Get the displayName property: API name.
        Returns:
        the displayName value.

      • withDisplayName

        public ApiContractUpdateProperties withDisplayName​(String displayName)
        Set the displayName property: API name.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the ApiContractUpdateProperties object itself.

      • serviceUrl

        public String serviceUrl()
        Get the serviceUrl property: Absolute URL of the backend service implementing this API.
        Returns:
        the serviceUrl value.

      • withServiceUrl

        public ApiContractUpdateProperties withServiceUrl​(String serviceUrl)
        Set the serviceUrl property: Absolute URL of the backend service implementing this API.
        Parameters:
        serviceUrl - the serviceUrl value to set.
        Returns:
        the ApiContractUpdateProperties 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 ApiContractUpdateProperties 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 ApiContractUpdateProperties 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 ApiContractUpdateProperties 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 ApiContractUpdateProperties object itself.

      • withDescription

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

      • withApiRevision

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

      • withApiVersion

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

      • withApiRevisionDescription

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

      • withApiVersionSetId

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

      • withSubscriptionRequired

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

      • withTermsOfServiceUrl

        public ApiContractUpdateProperties 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.
        Overrides:
        withTermsOfServiceUrl in class ApiEntityBaseContract
        Parameters:
        termsOfServiceUrl - the termsOfServiceUrl value to set.
        Returns:
        the ApiEntityBaseContract object itself.