SubscriptionCreateParameters Class

Definition

Subscription create details.

public class SubscriptionCreateParameters
Inheritance
java.lang.Object
SubscriptionCreateParameters

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) 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(long) java.lang.Object.wait(long,int)

Constructors

SubscriptionCreateParameters()

Methods

allowTracing()

Get determines whether tracing can be enabled.

displayName()

Get subscription name.

ownerId()

Get user (user id path) for whom subscription is being created in form /users/{userId}.

primaryKey()

Get primary subscription key. If not specified during request key will be generated automatically.

scope()

Get scope like /products/{productId} or /apis or /apis/{apiId}.

secondaryKey()

Get secondary subscription key. If not specified during request key will be generated automatically.

state()

Get initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active \u2013 the subscription is active, * suspended \u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted \u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected \u2013 the subscription request has been denied by an administrator, * cancelled \u2013 the subscription has been cancelled by the developer or administrator, * expired \u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'.

withAllowTracing(Boolean allowTracing)

Set determines whether tracing can be enabled.

withDisplayName(String displayName)

Set subscription name.

withOwnerId(String ownerId)

Set user (user id path) for whom subscription is being created in form /users/{userId}.

withPrimaryKey(String primaryKey)

Set primary subscription key. If not specified during request key will be generated automatically.

withScope(String scope)

Set scope like /products/{productId} or /apis or /apis/{apiId}.

withSecondaryKey(String secondaryKey)

Set secondary subscription key. If not specified during request key will be generated automatically.

withState(SubscriptionState state)

Set initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active \u2013 the subscription is active, * suspended \u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted \u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected \u2013 the subscription request has been denied by an administrator, * cancelled \u2013 the subscription has been cancelled by the developer or administrator, * expired \u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'.

Applies to