Class ProductContractProperties
- java.lang.Object
-
- com.azure.resourcemanager.apimanagement.models.ProductEntityBaseParameters
-
- com.azure.resourcemanager.apimanagement.fluent.models.ProductContractProperties
-
public final class ProductContractProperties extends ProductEntityBaseParameters
Product profile.
-
-
Constructor Summary
Constructors Constructor Description ProductContractProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
displayName()
Get the displayName property: Product name.void
validate()
Validates the instance.ProductContractProperties
withApprovalRequired(Boolean approvalRequired)
Set the approvalRequired property: whether subscription approval is required.ProductContractProperties
withDescription(String description)
Set the description property: Product description.ProductContractProperties
withDisplayName(String displayName)
Set the displayName property: Product name.ProductContractProperties
withState(ProductState state)
Set the state property: whether product is published or not.ProductContractProperties
withSubscriptionRequired(Boolean subscriptionRequired)
Set the subscriptionRequired property: Whether a product subscription is required for accessing APIs included in this product.ProductContractProperties
withSubscriptionsLimit(Integer subscriptionsLimit)
Set the subscriptionsLimit property: Whether the number of subscriptions a user can have to this product at the same time.ProductContractProperties
withTerms(String terms)
Set the terms property: Product terms of use.-
Methods inherited from class com.azure.resourcemanager.apimanagement.models.ProductEntityBaseParameters
approvalRequired, description, state, subscriptionRequired, subscriptionsLimit, terms
-
-
-
-
Method Detail
-
displayName
public String displayName()
Get the displayName property: Product name.- Returns:
- the displayName value.
-
withDisplayName
public ProductContractProperties withDisplayName(String displayName)
Set the displayName property: Product name.- Parameters:
displayName
- the displayName value to set.- Returns:
- the ProductContractProperties object itself.
-
withDescription
public ProductContractProperties withDescription(String description)
Set the description property: Product description. May include HTML formatting tags.- Overrides:
withDescription
in classProductEntityBaseParameters
- Parameters:
description
- the description value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
withTerms
public ProductContractProperties 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.- Overrides:
withTerms
in classProductEntityBaseParameters
- Parameters:
terms
- the terms value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
withSubscriptionRequired
public ProductContractProperties 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.- Overrides:
withSubscriptionRequired
in classProductEntityBaseParameters
- Parameters:
subscriptionRequired
- the subscriptionRequired value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
withApprovalRequired
public ProductContractProperties 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.- Overrides:
withApprovalRequired
in classProductEntityBaseParameters
- Parameters:
approvalRequired
- the approvalRequired value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
withSubscriptionsLimit
public ProductContractProperties 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.- Overrides:
withSubscriptionsLimit
in classProductEntityBaseParameters
- Parameters:
subscriptionsLimit
- the subscriptionsLimit value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
withState
public ProductContractProperties 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.- Overrides:
withState
in classProductEntityBaseParameters
- Parameters:
state
- the state value to set.- Returns:
- the ProductEntityBaseParameters object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classProductEntityBaseParameters
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-