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

Class ApiCreateOrUpdateProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract
com.azure.resourcemanager.apimanagement.fluent.models.ApiContractProperties
com.azure.resourcemanager.apimanagement.fluent.models.ApiCreateOrUpdateProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiEntityBaseContract>
public final class ApiCreateOrUpdateProperties extends ApiContractProperties
API Create or Update Properties.

  • Constructor Details

    • ApiCreateOrUpdateProperties

      public ApiCreateOrUpdateProperties()
      Creates an instance of ApiCreateOrUpdateProperties class.

  • Method Details

    • 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. New formats can be added in the future.
      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. New formats can be added in the future.
      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. New types can be added in the future.
      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. New types can be added in the future.
      Parameters:
      soapApiType - the soapApiType value to set.
      Returns:
      the ApiCreateOrUpdateProperties object itself.

    • translateRequiredQueryParametersConduct

      public TranslateRequiredQueryParametersConduct translateRequiredQueryParametersConduct()
      Get the translateRequiredQueryParametersConduct property: Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'.
      Returns:
      the translateRequiredQueryParametersConduct value.

    • withTranslateRequiredQueryParametersConduct

      public ApiCreateOrUpdateProperties withTranslateRequiredQueryParametersConduct(TranslateRequiredQueryParametersConduct translateRequiredQueryParametersConduct)
      Set the translateRequiredQueryParametersConduct property: Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'.
      Parameters:
      translateRequiredQueryParametersConduct - the translateRequiredQueryParametersConduct value to set.
      Returns:
      the ApiCreateOrUpdateProperties object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The provisioning state.
      Overrides:
      provisioningState in class ApiContractProperties
      Returns:
      the provisioningState value.

    • isOnline

      public Boolean isOnline()
      Get the isOnline property: Indicates if API revision is accessible via the gateway.
      Overrides:
      isOnline in class ApiContractProperties
      Returns:
      the isOnline value.

    • withSourceApiId

      public ApiCreateOrUpdateProperties withSourceApiId(String sourceApiId)
      Set the sourceApiId property: API identifier of the source API.
      Overrides:
      withSourceApiId in class ApiContractProperties
      Parameters:
      sourceApiId - the sourceApiId value to set.
      Returns:
      the ApiContractProperties object itself.

    • withDisplayName

      public ApiCreateOrUpdateProperties withDisplayName(String displayName)
      Set the displayName property: API name. Must be 1 to 300 characters long.
      Overrides:
      withDisplayName in class ApiContractProperties
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ApiContractProperties 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.

    • withProtocols

      public ApiCreateOrUpdateProperties withProtocols(List<Protocol> protocols)
      Set the protocols property: Describes on which protocols the operations in this API can be invoked.
      Overrides:
      withProtocols in class ApiContractProperties
      Parameters:
      protocols - the protocols value to set.
      Returns:
      the ApiContractProperties object itself.

    • withApiVersionSet

      public ApiCreateOrUpdateProperties withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)
      Set the apiVersionSet property: Version set details.
      Overrides:
      withApiVersionSet in class ApiContractProperties
      Parameters:
      apiVersionSet - the apiVersionSet 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.

    • withAuthenticationSettings

      public ApiCreateOrUpdateProperties withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)
      Set the authenticationSettings property: Collection of authentication settings included into this API.
      Overrides:
      withAuthenticationSettings in class ApiContractProperties
      Parameters:
      authenticationSettings - the authenticationSettings value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • withSubscriptionKeyParameterNames

      public ApiCreateOrUpdateProperties withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)
      Set the subscriptionKeyParameterNames property: Protocols over which API is made available.
      Overrides:
      withSubscriptionKeyParameterNames in class ApiContractProperties
      Parameters:
      subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • withApiType

      public ApiCreateOrUpdateProperties withApiType(ApiType apiType)
      Set the apiType property: Type of API.
      Overrides:
      withApiType in class ApiContractProperties
      Parameters:
      apiType - the apiType 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.

    • withIsCurrent

      public ApiCreateOrUpdateProperties withIsCurrent(Boolean isCurrent)
      Set the isCurrent property: Indicates if API revision is current api revision.
      Overrides:
      withIsCurrent in class ApiContractProperties
      Parameters:
      isCurrent - the isCurrent 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.

    • withApiVersionDescription

      public ApiCreateOrUpdateProperties withApiVersionDescription(String apiVersionDescription)
      Set the apiVersionDescription property: Description of the API Version.
      Overrides:
      withApiVersionDescription in class ApiContractProperties
      Parameters:
      apiVersionDescription - the apiVersionDescription 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.

    • withContact

      public ApiCreateOrUpdateProperties withContact(ApiContactInformation contact)
      Set the contact property: Contact information for the API.
      Overrides:
      withContact in class ApiContractProperties
      Parameters:
      contact - the contact value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • withLicense

      public ApiCreateOrUpdateProperties withLicense(ApiLicenseInformation license)
      Set the license property: License information for the API.
      Overrides:
      withLicense in class ApiContractProperties
      Parameters:
      license - the license value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ApiEntityBaseContract>
      Overrides:
      toJson in class ApiContractProperties
      Throws:
      IOException

    • fromJson

      public static ApiCreateOrUpdateProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiCreateOrUpdateProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiCreateOrUpdateProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ApiCreateOrUpdateProperties.