Package org.wso2.am.integration.clients.admin.api.dto

Class SubscriptionThrottlePolicyDTO

java.lang.Object

org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO

org.wso2.am.integration.clients.admin.api.dto.SubscriptionThrottlePolicyDTO

public class SubscriptionThrottlePolicyDTO
extends ThrottlePolicyDTO

SubscriptionThrottlePolicyDTO

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_BILLING_PLAN
static final String	SERIALIZED_NAME_CUSTOM_ATTRIBUTES
static final String	SERIALIZED_NAME_DEFAULT_LIMIT
static final String	SERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITY
static final String	SERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTH
static final String	SERIALIZED_NAME_MONETIZATION
static final String	SERIALIZED_NAME_PERMISSIONS
static final String	SERIALIZED_NAME_RATE_LIMIT_COUNT
static final String	SERIALIZED_NAME_RATE_LIMIT_TIME_UNIT
static final String	SERIALIZED_NAME_STOP_ON_QUOTA_REACH
static final String	SERIALIZED_NAME_SUBSCRIBER_COUNT

Fields inherited from class org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO

SERIALIZED_NAME_DESCRIPTION, SERIALIZED_NAME_DISPLAY_NAME, SERIALIZED_NAME_IS_DEPLOYED, SERIALIZED_NAME_POLICY_ID, SERIALIZED_NAME_POLICY_NAME, SERIALIZED_NAME_TYPE, type

Constructor Summary

Constructors

Constructor	Description
SubscriptionThrottlePolicyDTO()

Method Summary

Modifier and Type	Method	Description
SubscriptionThrottlePolicyDTO	billingPlan(String billingPlan)
SubscriptionThrottlePolicyDTO	customAttributes(List<CustomAttributeDTO> customAttributes)
SubscriptionThrottlePolicyDTO	defaultLimit(ThrottleLimitDTO defaultLimit)
boolean	equals(Object o)
String	getBillingPlan()	define whether this is Paid or a Free plan.
List<CustomAttributeDTO>	getCustomAttributes()	Custom attributes added to the Subscription Throttling Policy
ThrottleLimitDTO	getDefaultLimit()	Get defaultLimit
Integer	getGraphQLMaxComplexity()	Maximum Complexity of the GraphQL query
Integer	getGraphQLMaxDepth()	Maximum Depth of the GraphQL query
MonetizationInfoDTO	getMonetization()	Get monetization
SubscriptionThrottlePolicyPermissionDTO	getPermissions()	Get permissions
Integer	getRateLimitCount()	Burst control request count
String	getRateLimitTimeUnit()	Burst control time unit
Integer	getSubscriberCount()	Number of subscriptions allowed
SubscriptionThrottlePolicyDTO	graphQLMaxComplexity(Integer graphQLMaxComplexity)
SubscriptionThrottlePolicyDTO	graphQLMaxDepth(Integer graphQLMaxDepth)
int	hashCode()
Boolean	isStopOnQuotaReach()	This indicates the action to be taken when a user goes beyond the allocated quota.
SubscriptionThrottlePolicyDTO	monetization(MonetizationInfoDTO monetization)
SubscriptionThrottlePolicyDTO	permissions(SubscriptionThrottlePolicyPermissionDTO permissions)
SubscriptionThrottlePolicyDTO	rateLimitCount(Integer rateLimitCount)
SubscriptionThrottlePolicyDTO	rateLimitTimeUnit(String rateLimitTimeUnit)
void	setBillingPlan(String billingPlan)
void	setCustomAttributes(List<CustomAttributeDTO> customAttributes)
void	setDefaultLimit(ThrottleLimitDTO defaultLimit)
void	setGraphQLMaxComplexity(Integer graphQLMaxComplexity)
void	setGraphQLMaxDepth(Integer graphQLMaxDepth)
void	setMonetization(MonetizationInfoDTO monetization)
void	setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
void	setSubscriberCount(Integer subscriberCount)
SubscriptionThrottlePolicyDTO	stopOnQuotaReach(Boolean stopOnQuotaReach)
SubscriptionThrottlePolicyDTO	subscriberCount(Integer subscriberCount)
String	toString()

Methods inherited from class org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO

description, displayName, getDescription, getDisplayName, getPolicyId, getPolicyName, getType, isDeployed, isIsDeployed, policyId, policyName, setDescription, setDisplayName, setIsDeployed, setPolicyId, setPolicyName, setType, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITY

public static final String SERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITY

See Also:

• Constant Field Values

SERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTH

public static final String SERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTH

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_LIMIT

public static final String SERIALIZED_NAME_DEFAULT_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_MONETIZATION

public static final String SERIALIZED_NAME_MONETIZATION

See Also:

• Constant Field Values

SERIALIZED_NAME_RATE_LIMIT_COUNT

public static final String SERIALIZED_NAME_RATE_LIMIT_COUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_RATE_LIMIT_TIME_UNIT

public static final String SERIALIZED_NAME_RATE_LIMIT_TIME_UNIT

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOM_ATTRIBUTES

public static final String SERIALIZED_NAME_CUSTOM_ATTRIBUTES

See Also:

• Constant Field Values

SERIALIZED_NAME_STOP_ON_QUOTA_REACH

public static final String SERIALIZED_NAME_STOP_ON_QUOTA_REACH

See Also:

• Constant Field Values

SERIALIZED_NAME_BILLING_PLAN

public static final String SERIALIZED_NAME_BILLING_PLAN

See Also:

• Constant Field Values

SERIALIZED_NAME_PERMISSIONS

public static final String SERIALIZED_NAME_PERMISSIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_SUBSCRIBER_COUNT

public static final String SERIALIZED_NAME_SUBSCRIBER_COUNT

See Also:

• Constant Field Values

Constructor Details

SubscriptionThrottlePolicyDTO

public SubscriptionThrottlePolicyDTO()

Method Details

graphQLMaxComplexity

public SubscriptionThrottlePolicyDTO graphQLMaxComplexity(Integer graphQLMaxComplexity)

getGraphQLMaxComplexity

@Nullable
public Integer getGraphQLMaxComplexity()

Maximum Complexity of the GraphQL query

Returns:

graphQLMaxComplexity

setGraphQLMaxComplexity

public void setGraphQLMaxComplexity(Integer graphQLMaxComplexity)

graphQLMaxDepth

public SubscriptionThrottlePolicyDTO graphQLMaxDepth(Integer graphQLMaxDepth)

getGraphQLMaxDepth

@Nullable
public Integer getGraphQLMaxDepth()

Maximum Depth of the GraphQL query

Returns:

graphQLMaxDepth

setGraphQLMaxDepth

public void setGraphQLMaxDepth(Integer graphQLMaxDepth)

defaultLimit

public SubscriptionThrottlePolicyDTO defaultLimit(ThrottleLimitDTO defaultLimit)

getDefaultLimit

public ThrottleLimitDTO getDefaultLimit()

Get defaultLimit

Returns:

defaultLimit

setDefaultLimit

public void setDefaultLimit(ThrottleLimitDTO defaultLimit)

monetization

public SubscriptionThrottlePolicyDTO monetization(MonetizationInfoDTO monetization)

getMonetization

@Nullable
public MonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(MonetizationInfoDTO monetization)

rateLimitCount

public SubscriptionThrottlePolicyDTO rateLimitCount(Integer rateLimitCount)

getRateLimitCount

@Nullable
public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public SubscriptionThrottlePolicyDTO rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

@Nullable
public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

customAttributes

public SubscriptionThrottlePolicyDTO customAttributes(List<CustomAttributeDTO> customAttributes)

getCustomAttributes

@Nullable
public List<CustomAttributeDTO> getCustomAttributes()

Custom attributes added to the Subscription Throttling Policy

Returns:

customAttributes

setCustomAttributes

public void setCustomAttributes(List<CustomAttributeDTO> customAttributes)

stopOnQuotaReach

public SubscriptionThrottlePolicyDTO stopOnQuotaReach(Boolean stopOnQuotaReach)

isStopOnQuotaReach

@Nullable
public Boolean isStopOnQuotaReach()

This indicates the action to be taken when a user goes beyond the allocated quota. If checked, the user's requests will be dropped. If unchecked, the requests will be allowed to pass through.

Returns:

stopOnQuotaReach

setStopOnQuotaReach

public void setStopOnQuotaReach(Boolean stopOnQuotaReach)

billingPlan

public SubscriptionThrottlePolicyDTO billingPlan(String billingPlan)

getBillingPlan

@Nullable
public String getBillingPlan()

define whether this is Paid or a Free plan. Allowed values are FREE or COMMERCIAL.

Returns:

billingPlan

setBillingPlan

public void setBillingPlan(String billingPlan)

permissions

public SubscriptionThrottlePolicyDTO permissions(SubscriptionThrottlePolicyPermissionDTO permissions)

getPermissions

@Nullable
public SubscriptionThrottlePolicyPermissionDTO getPermissions()

Get permissions

Returns:

permissions

setPermissions

public void setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)

subscriberCount

public SubscriptionThrottlePolicyDTO subscriberCount(Integer subscriberCount)

getSubscriberCount

@Nullable
public Integer getSubscriberCount()

Number of subscriptions allowed

Returns:

subscriberCount

setSubscriberCount

public void setSubscriberCount(Integer subscriberCount)

equals

public boolean equals(Object o)

Overrides:

equals in class ThrottlePolicyDTO

hashCode

public int hashCode()

Overrides:

hashCode in class ThrottlePolicyDTO

toString

public String toString()

Overrides:

toString in class ThrottlePolicyDTO