Package com.azure.resourcemanager.apimanagement.models

Class ProductUpdateParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ProductUpdateParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<ProductUpdateParameters>
public final class ProductUpdateParameters extends Object implements com.azure.json.JsonSerializable<ProductUpdateParameters>
Product Update parameters.

  • Constructor Details

    • ProductUpdateParameters

      public ProductUpdateParameters()
      Creates an instance of ProductUpdateParameters class.

  • Method Details

    • displayName

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

    • withDisplayName

      public ProductUpdateParameters withDisplayName(String displayName)
      Set the displayName property: Product name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • description

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

    • withDescription

      public ProductUpdateParameters withDescription(String description)
      Set the description property: Product description. May include HTML formatting tags.
      Parameters:
      description - the description value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • terms

      public String terms()
      Get the terms property: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
      Returns:
      the terms value.

    • withTerms

      public ProductUpdateParameters withTerms(String terms)
      Set the terms property: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
      Parameters:
      terms - the terms value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • subscriptionRequired

      public Boolean subscriptionRequired()
      Get the subscriptionRequired property: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
      Returns:
      the subscriptionRequired value.

    • withSubscriptionRequired

      public ProductUpdateParameters withSubscriptionRequired(Boolean subscriptionRequired)
      Set the subscriptionRequired property: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
      Parameters:
      subscriptionRequired - the subscriptionRequired value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • approvalRequired

      public Boolean approvalRequired()
      Get the approvalRequired property: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
      Returns:
      the approvalRequired value.

    • withApprovalRequired

      public ProductUpdateParameters withApprovalRequired(Boolean approvalRequired)
      Set the approvalRequired property: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
      Parameters:
      approvalRequired - the approvalRequired value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • subscriptionsLimit

      public Integer subscriptionsLimit()
      Get the subscriptionsLimit property: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
      Returns:
      the subscriptionsLimit value.

    • withSubscriptionsLimit

      public ProductUpdateParameters withSubscriptionsLimit(Integer subscriptionsLimit)
      Set the subscriptionsLimit property: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
      Parameters:
      subscriptionsLimit - the subscriptionsLimit value to set.
      Returns:
      the ProductUpdateParameters object itself.

    • state

      public ProductState state()
      Get the state property: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
      Returns:
      the state value.

    • withState

      public ProductUpdateParameters withState(ProductState state)
      Set the state property: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
      Parameters:
      state - the state value to set.
      Returns:
      the ProductUpdateParameters 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<ProductUpdateParameters>
      Throws:
      IOException

    • fromJson

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