Package com.azure.resourcemanager.apimanagement.models

Class ApiCreateOrUpdateParameter

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiCreateOrUpdateParameter
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiCreateOrUpdateParameter>
public final class ApiCreateOrUpdateParameter extends Object implements com.azure.json.JsonSerializable<ApiCreateOrUpdateParameter>
API Create or Update Parameters.

  • Constructor Details

    • ApiCreateOrUpdateParameter

      public ApiCreateOrUpdateParameter()
      Creates an instance of ApiCreateOrUpdateParameter class.

  • Method Details

    • value

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

    • withValue

      public ApiCreateOrUpdateParameter withValue(String value)
      Set the value property: Content value when Importing an API.
      Parameters:
      value - the value value to set.
      Returns:
      the ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter 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 ApiCreateOrUpdateParameter object itself.

    • sourceApiId

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

    • withSourceApiId

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

    • apiVersionSet

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

    • withApiVersionSet

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

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The provisioning state.
      Returns:
      the provisioningState value.

    • description

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

    • withDescription

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

    • authenticationSettings

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

    • withAuthenticationSettings

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

    • subscriptionKeyParameterNames

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

    • withSubscriptionKeyParameterNames

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

    • apiType

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

    • withApiType

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

    • isCurrent

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

    • withIsCurrent

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

    • apiVersionDescription

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

    • withApiVersionDescription

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

    • apiVersionSetId

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

    • withApiVersionSetId

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

    • contact

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

    • withContact

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

    • license

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

    • withLicense

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

    • validate

      public void validate()
      Validates the instance.
      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<ApiCreateOrUpdateParameter>
      Throws:
      IOException

    • fromJson

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