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

Class ApiCreateOrUpdateProperties

  • public final class ApiCreateOrUpdateProperties
extends ApiContractProperties
    API Create or Update Properties.

    • Constructor Detail

      • ApiCreateOrUpdateProperties

        public ApiCreateOrUpdateProperties()

    • Method Detail

      • value

        public String value()
        Get the value property: Content value when Importing an API.
        Returns:
        the value value.

      • withValue

        public ApiCreateOrUpdateProperties withValue​(String value)
        Set the value property: Content value when Importing an API.
        Parameters:
        value - the value value to set.
        Returns:
        the ApiCreateOrUpdateProperties object itself.

      • format

        public ContentFormat format()
        Get the format property: Format of the Content in which the API is getting imported.
        Returns:
        the format value.

      • withFormat

        public ApiCreateOrUpdateProperties withFormat​(ContentFormat format)
        Set the format property: Format of the Content in which the API is getting imported.
        Parameters:
        format - the format value to set.
        Returns:
        the ApiCreateOrUpdateProperties object itself.

      • wsdlSelector

        public ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector()
        Get the wsdlSelector property: Criteria to limit import of WSDL to a subset of the document.
        Returns:
        the wsdlSelector value.

      • withWsdlSelector

        public ApiCreateOrUpdateProperties withWsdlSelector​(ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector)
        Set the wsdlSelector property: Criteria to limit import of WSDL to a subset of the document.
        Parameters:
        wsdlSelector - the wsdlSelector value to set.
        Returns:
        the ApiCreateOrUpdateProperties object itself.

      • soapApiType

        public SoapApiType soapApiType()
        Get the soapApiType property: Type of API to create. * `http` creates a REST API * `soap` creates a SOAP pass-through API * `websocket` creates websocket API * `graphql` creates GraphQL API.
        Returns:
        the soapApiType value.

      • withSoapApiType

        public ApiCreateOrUpdateProperties withSoapApiType​(SoapApiType soapApiType)
        Set the soapApiType property: Type of API to create. * `http` creates a REST API * `soap` creates a SOAP pass-through API * `websocket` creates websocket API * `graphql` creates GraphQL API.
        Parameters:
        soapApiType - the soapApiType value to set.
        Returns:
        the ApiCreateOrUpdateProperties object itself.

      • withServiceUrl

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

      • withPath

        public ApiCreateOrUpdateProperties 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.
        Overrides:
        withPath in class ApiContractProperties
        Parameters:
        path - the path value to set.
        Returns:
        the ApiContractProperties object itself.

      • withDescription

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

      • withApiRevision

        public ApiCreateOrUpdateProperties 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 ApiContractProperties
        Parameters:
        apiRevision - the apiRevision value to set.
        Returns:
        the ApiEntityBaseContract object itself.

      • withApiVersion

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

      • withApiRevisionDescription

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

      • withApiVersionSetId

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

      • withSubscriptionRequired

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

      • withTermsOfServiceUrl

        public ApiCreateOrUpdateProperties 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 ApiContractProperties
        Parameters:
        termsOfServiceUrl - the termsOfServiceUrl value to set.
        Returns:
        the ApiEntityBaseContract object itself.