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

Constructor Summary

Constructors

Constructor and Description
SubscriptionThrottlePolicyDTO()

Method Summary

Modifier and Type	Method and Description
SubscriptionThrottlePolicyDTO	addCustomAttributesItem(CustomAttributeDTO customAttributesItem)
SubscriptionThrottlePolicyDTO	billingPlan(String billingPlan)
SubscriptionThrottlePolicyDTO	customAttributes(List<CustomAttributeDTO> customAttributes)
SubscriptionThrottlePolicyDTO	defaultLimit(ThrottleLimitTypeDTO 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
ThrottleLimitTypeDTO	getDefaultLimit() Get defaultLimit
Integer	getGraphQLMaxComplexity() Maximum Complexity of the GraphQL query
Integer	getGraphQLMaxDepth() Maximum Depth of the GraphQL query
MonetizationInfoDTO	getMonetization() Get monetization
Integer	getRateLimitCount() Burst control request count
String	getRateLimitTimeUnit() Burst control time unit
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	rateLimitCount(Integer rateLimitCount)
SubscriptionThrottlePolicyDTO	rateLimitTimeUnit(String rateLimitTimeUnit)
void	setBillingPlan(String billingPlan)
void	setCustomAttributes(List<CustomAttributeDTO> customAttributes)
void	setDefaultLimit(ThrottleLimitTypeDTO defaultLimit)
void	setGraphQLMaxComplexity(Integer graphQLMaxComplexity)
void	setGraphQLMaxDepth(Integer graphQLMaxDepth)
void	setMonetization(MonetizationInfoDTO monetization)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
SubscriptionThrottlePolicyDTO	stopOnQuotaReach(Boolean stopOnQuotaReach)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionThrottlePolicyDTO

public SubscriptionThrottlePolicyDTO()

Method Detail

graphQLMaxComplexity

public SubscriptionThrottlePolicyDTO graphQLMaxComplexity(Integer graphQLMaxComplexity)

getGraphQLMaxComplexity

public Integer getGraphQLMaxComplexity()

Maximum Complexity of the GraphQL query

Returns:

graphQLMaxComplexity

setGraphQLMaxComplexity

public void setGraphQLMaxComplexity(Integer graphQLMaxComplexity)

graphQLMaxDepth

public SubscriptionThrottlePolicyDTO graphQLMaxDepth(Integer graphQLMaxDepth)

getGraphQLMaxDepth

public Integer getGraphQLMaxDepth()

Maximum Depth of the GraphQL query

Returns:

graphQLMaxDepth

setGraphQLMaxDepth

public void setGraphQLMaxDepth(Integer graphQLMaxDepth)

defaultLimit

public SubscriptionThrottlePolicyDTO defaultLimit(ThrottleLimitTypeDTO defaultLimit)

getDefaultLimit

public ThrottleLimitTypeDTO getDefaultLimit()

Get defaultLimit

Returns:

defaultLimit

setDefaultLimit

public void setDefaultLimit(ThrottleLimitTypeDTO defaultLimit)

monetization

public SubscriptionThrottlePolicyDTO monetization(MonetizationInfoDTO monetization)

getMonetization

public MonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(MonetizationInfoDTO monetization)

rateLimitCount

public SubscriptionThrottlePolicyDTO rateLimitCount(Integer rateLimitCount)

getRateLimitCount

public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public SubscriptionThrottlePolicyDTO rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

customAttributes

public SubscriptionThrottlePolicyDTO customAttributes(List<CustomAttributeDTO> customAttributes)

addCustomAttributesItem

public SubscriptionThrottlePolicyDTO addCustomAttributesItem(CustomAttributeDTO customAttributesItem)

getCustomAttributes

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

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

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)

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