Interface ProductContract.DefinitionStages.WithSubscriptionRequired
- All Known Subinterfaces:
ProductContract.Definition,ProductContract.DefinitionStages.WithCreate
- Enclosing interface:
ProductContract.DefinitionStages
public static interface ProductContract.DefinitionStages.WithSubscriptionRequired
The stage of the ProductContract definition allowing to specify subscriptionRequired.
-
Method Summary
Modifier and TypeMethodDescriptionwithSubscriptionRequired(Boolean subscriptionRequired) Specifies the subscriptionRequired property: Whether a product subscription is required for accessing APIs included in this product.
-
Method Details
-
withSubscriptionRequired
Specifies 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- 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 next definition stage.
-