180 строки
16 KiB
YAML
180 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters"
|
|
name: "ProductEntityBaseParameters"
|
|
nameWithType: "ProductEntityBaseParameters"
|
|
summary: "Product Entity Base Parameters."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **ProductEntityBaseParameters**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.ProductEntityBaseParameters()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.ProductEntityBaseParameters()"
|
|
name: "ProductEntityBaseParameters()"
|
|
nameWithType: "ProductEntityBaseParameters.ProductEntityBaseParameters()"
|
|
syntax: "public ProductEntityBaseParameters()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.approvalRequired()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.approvalRequired()"
|
|
name: "approvalRequired()"
|
|
nameWithType: "ProductEntityBaseParameters.approvalRequired()"
|
|
summary: "Get whether subscription approval is required."
|
|
syntax: "public Boolean approvalRequired()"
|
|
desc: "Get whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product\\\\u2019s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product\\\\u2019s APIs. Can be present only if subscriptionRequired property is present and has a value of false."
|
|
returns:
|
|
description: "the approvalRequired value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.description()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.description()"
|
|
name: "description()"
|
|
nameWithType: "ProductEntityBaseParameters.description()"
|
|
summary: "Get product description."
|
|
syntax: "public String description()"
|
|
desc: "Get product description. May include HTML formatting tags."
|
|
returns:
|
|
description: "the description value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.state()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.state()"
|
|
name: "state()"
|
|
nameWithType: "ProductEntityBaseParameters.state()"
|
|
summary: "Get whether product is published or not."
|
|
syntax: "public ProductState state()"
|
|
desc: "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:
|
|
description: "the state value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductState&text=ProductState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.subscriptionRequired()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.subscriptionRequired()"
|
|
name: "subscriptionRequired()"
|
|
nameWithType: "ProductEntityBaseParameters.subscriptionRequired()"
|
|
summary: "Get whether a product subscription is required for accessing APIs included in this product."
|
|
syntax: "public Boolean subscriptionRequired()"
|
|
desc: "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:
|
|
description: "the subscriptionRequired value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.subscriptionsLimit()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.subscriptionsLimit()"
|
|
name: "subscriptionsLimit()"
|
|
nameWithType: "ProductEntityBaseParameters.subscriptionsLimit()"
|
|
summary: "Get whether the number of subscriptions a user can have to this product at the same time."
|
|
syntax: "public Integer subscriptionsLimit()"
|
|
desc: "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:
|
|
description: "the subscriptionsLimit value"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.terms()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.terms()"
|
|
name: "terms()"
|
|
nameWithType: "ProductEntityBaseParameters.terms()"
|
|
summary: "Get product terms of use."
|
|
syntax: "public String terms()"
|
|
desc: "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:
|
|
description: "the terms value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withApprovalRequired(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withApprovalRequired(Boolean approvalRequired)"
|
|
name: "withApprovalRequired(Boolean approvalRequired)"
|
|
nameWithType: "ProductEntityBaseParameters.withApprovalRequired(Boolean approvalRequired)"
|
|
summary: "Set whether subscription approval is required."
|
|
parameters:
|
|
- description: "the approvalRequired value to set"
|
|
name: "approvalRequired"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withApprovalRequired(Boolean approvalRequired)"
|
|
desc: "Set whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product\\\\u2019s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product\\\\u2019s APIs. Can be present only if subscriptionRequired property is present and has a value of false."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withDescription(String description)"
|
|
name: "withDescription(String description)"
|
|
nameWithType: "ProductEntityBaseParameters.withDescription(String description)"
|
|
summary: "Set product description."
|
|
parameters:
|
|
- description: "the description value to set"
|
|
name: "description"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withDescription(String description)"
|
|
desc: "Set product description. May include HTML formatting tags."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withState(com.microsoft.azure.management.apimanagement.v2019_01_01.ProductState)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withState(ProductState state)"
|
|
name: "withState(ProductState state)"
|
|
nameWithType: "ProductEntityBaseParameters.withState(ProductState state)"
|
|
summary: "Set whether product is published or not."
|
|
parameters:
|
|
- description: "the state value to set"
|
|
name: "state"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductState&text=ProductState\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withState(ProductState state)"
|
|
desc: "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'."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withSubscriptionRequired(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
name: "withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
nameWithType: "ProductEntityBaseParameters.withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
summary: "Set whether a product subscription is required for accessing APIs included in this product."
|
|
parameters:
|
|
- description: "the subscriptionRequired value to set"
|
|
name: "subscriptionRequired"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withSubscriptionsLimit(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withSubscriptionsLimit(Integer subscriptionsLimit)"
|
|
name: "withSubscriptionsLimit(Integer subscriptionsLimit)"
|
|
nameWithType: "ProductEntityBaseParameters.withSubscriptionsLimit(Integer subscriptionsLimit)"
|
|
summary: "Set whether the number of subscriptions a user can have to this product at the same time."
|
|
parameters:
|
|
- description: "the subscriptionsLimit value to set"
|
|
name: "subscriptionsLimit"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withSubscriptionsLimit(Integer subscriptionsLimit)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withTerms(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters.withTerms(String terms)"
|
|
name: "withTerms(String terms)"
|
|
nameWithType: "ProductEntityBaseParameters.withTerms(String terms)"
|
|
summary: "Set product terms of use."
|
|
parameters:
|
|
- description: "the terms value to set"
|
|
name: "terms"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ProductEntityBaseParameters withTerms(String terms)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ProductEntityBaseParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ProductEntityBaseParameters&text=ProductEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Product Entity Base Parameters."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|