Share via

ProductUpdateParameters Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.management.apimanagement.v2019_01_01.ProductUpdateParameters

public class ProductUpdateParameters

Product Update parameters.

Constructor Summary

Constructor Description
ProductUpdateParameters()

Method Summary

Modifier and Type Method and Description
java.lang.Boolean approvalRequired()

Get whether subscription approval is required.
java.lang.String description()

Get product description.
java.lang.String displayName()

Get product name.
ProductState state()

Get whether product is published or not.
java.lang.Boolean subscriptionRequired()

Get whether a product subscription is required for accessing APIs included in this product.
java.lang.Integer subscriptionsLimit()

Get whether the number of subscriptions a user can have to this product at the same time.
java.lang.String terms()

Get product terms of use.
ProductUpdateParameters withApprovalRequired(Boolean approvalRequired)

Set whether subscription approval is required.
ProductUpdateParameters withDescription(String description)

Set product description.
ProductUpdateParameters withDisplayName(String displayName)

Set product name.
ProductUpdateParameters withState(ProductState state)

Set whether product is published or not.
ProductUpdateParameters withSubscriptionRequired(Boolean subscriptionRequired)

Set whether a product subscription is required for accessing APIs included in this product.
ProductUpdateParameters withSubscriptionsLimit(Integer subscriptionsLimit)

Set whether the number of subscriptions a user can have to this product at the same time.
ProductUpdateParameters withTerms(String terms)

Set product terms of use.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ProductUpdateParameters

public ProductUpdateParameters()

Method Details

approvalRequired

public Boolean approvalRequired()

Get 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

description

public String description()

Get product description. May include HTML formatting tags.

Returns:

the description value

displayName

public String displayName()

Get product name.

Returns:

the displayName value

state

public ProductState state()

Get 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. Possible values include: 'notPublished', 'published'.

Returns:

the state value

subscriptionRequired

public Boolean subscriptionRequired()

Get 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

subscriptionsLimit

public Integer subscriptionsLimit()

Get 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

terms

public String terms()

Get 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

withApprovalRequired

public ProductUpdateParameters withApprovalRequired(Boolean approvalRequired)

Set 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.

withDescription

public ProductUpdateParameters withDescription(String description)

Set product description. May include HTML formatting tags.

Parameters:

description - the description value to set

Returns:

the ProductUpdateParameters object itself.

withDisplayName

public ProductUpdateParameters withDisplayName(String displayName)

Set product name.

Parameters:

displayName - the displayName value to set

Returns:

the ProductUpdateParameters object itself.

withState

public ProductUpdateParameters withState(ProductState state)

Set 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. Possible values include: 'notPublished', 'published'.

Parameters:

state - the state value to set

Returns:

the ProductUpdateParameters object itself.

withSubscriptionRequired

public ProductUpdateParameters withSubscriptionRequired(Boolean subscriptionRequired)

Set 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.

withSubscriptionsLimit

public ProductUpdateParameters withSubscriptionsLimit(Integer subscriptionsLimit)

Set 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.

withTerms

public ProductUpdateParameters withTerms(String terms)

Set 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.

Applies to