Package com.azure.resourcemanager.apimanagement.models

Class ApiUpdateContract

  • public final class ApiUpdateContract
extends Object
    API update contract details.

    • Constructor Detail

      • ApiUpdateContract

        public ApiUpdateContract()

    • Method Detail

      • displayName

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

      • withDisplayName

        public ApiUpdateContract withDisplayName​(String displayName)
        Set the displayName property: API name.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the ApiUpdateContract 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 ApiUpdateContract 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 ApiUpdateContract 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 ApiUpdateContract 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 ApiUpdateContract 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 ApiUpdateContract 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 ApiUpdateContract object itself.

      • description

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

      • withDescription

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

      • authenticationSettings

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

      • withAuthenticationSettings

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

      • subscriptionKeyParameterNames

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

      • withSubscriptionKeyParameterNames

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

      • apiType

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

      • withApiType

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

      • isCurrent

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

      • withIsCurrent

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

      • apiVersionDescription

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

      • withApiVersionDescription

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

      • apiVersionSetId

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

      • withApiVersionSetId

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

      • contact

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

      • withContact

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

      • license

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

      • withLicense

        public ApiUpdateContract withLicense​(ApiLicenseInformation license)
        Set the license property: License information for the API.
        Parameters:
        license - the license value to set.
        Returns:
        the ApiUpdateContract object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.