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

Class ApiContractUpdateProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract
com.azure.resourcemanager.apimanagement.fluent.models.ApiContractUpdateProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiEntityBaseContract>
public final class ApiContractUpdateProperties extends ApiEntityBaseContract
API update contract properties.

  • Constructor Details

    • ApiContractUpdateProperties

      public ApiContractUpdateProperties()
      Creates an instance of ApiContractUpdateProperties class.

  • Method Details

    • displayName

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

    • withDisplayName

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

    • isOnline

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

    • withDescription

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

    • withAuthenticationSettings

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

    • withSubscriptionKeyParameterNames

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

    • withApiType

      public ApiContractUpdateProperties withApiType(ApiType apiType)
      Set the apiType property: Type of API.
      Overrides:
      withApiType in class ApiEntityBaseContract
      Parameters:
      apiType - the apiType value to set.
      Returns:
      the ApiEntityBaseContract object itself.

    • withApiRevision

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

    • withContact

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

    • withLicense

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

    • validate

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

    • fromJson

      public static ApiContractUpdateProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiContractUpdateProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiContractUpdateProperties 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 ApiContractUpdateProperties.