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

Class ApiContractProperties

    • Constructor Detail

      • ApiContractProperties

        public ApiContractProperties()

    • Method Detail

      • sourceApiId

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

      • withSourceApiId

        public ApiContractProperties withSourceApiId​(String sourceApiId)
        Set the sourceApiId property: API identifier of the source API.
        Parameters:
        sourceApiId - the sourceApiId value to set.
        Returns:
        the ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties object itself.

      • apiVersionSet

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

      • withApiVersionSet

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

      • withDescription

        public ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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.

      • withIsCurrent

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

      • withApiRevisionDescription

        public ApiContractProperties 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.

      • withApiVersionDescription

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

      • withApiVersionSetId

        public ApiContractProperties 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 ApiContractProperties 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 ApiContractProperties 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.