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

Class SubscriptionThrottlePolicyAllOfDTO

java.lang.Object

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

public class SubscriptionThrottlePolicyAllOfDTO
extends Object

SubscriptionThrottlePolicyAllOfDTO

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_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

Constructor Summary

Constructors

Constructor	Description
SubscriptionThrottlePolicyAllOfDTO()

Method Summary

Modifier and Type	Method	Description
SubscriptionThrottlePolicyAllOfDTO	billingPlan(String billingPlan)
SubscriptionThrottlePolicyAllOfDTO	customAttributes(List<CustomAttributeDTO> customAttributes)
SubscriptionThrottlePolicyAllOfDTO	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
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
int	hashCode()
Boolean	isStopOnQuotaReach()	This indicates the action to be taken when a user goes beyond the allocated quota.
SubscriptionThrottlePolicyAllOfDTO	monetization(MonetizationInfoDTO monetization)
SubscriptionThrottlePolicyAllOfDTO	permissions(SubscriptionThrottlePolicyPermissionDTO permissions)
SubscriptionThrottlePolicyAllOfDTO	rateLimitCount(Integer rateLimitCount)
SubscriptionThrottlePolicyAllOfDTO	rateLimitTimeUnit(String rateLimitTimeUnit)
void	setBillingPlan(String billingPlan)
void	setCustomAttributes(List<CustomAttributeDTO> customAttributes)
void	setDefaultLimit(ThrottleLimitDTO defaultLimit)
void	setMonetization(MonetizationInfoDTO monetization)
void	setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
void	setSubscriberCount(Integer subscriberCount)
SubscriptionThrottlePolicyAllOfDTO	stopOnQuotaReach(Boolean stopOnQuotaReach)
SubscriptionThrottlePolicyAllOfDTO	subscriberCount(Integer subscriberCount)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

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

SubscriptionThrottlePolicyAllOfDTO

public SubscriptionThrottlePolicyAllOfDTO()

Method Details

defaultLimit

public SubscriptionThrottlePolicyAllOfDTO defaultLimit(ThrottleLimitDTO defaultLimit)

getDefaultLimit

public ThrottleLimitDTO getDefaultLimit()

Get defaultLimit

Returns:

defaultLimit

setDefaultLimit

public void setDefaultLimit(ThrottleLimitDTO defaultLimit)

monetization

public SubscriptionThrottlePolicyAllOfDTO monetization(MonetizationInfoDTO monetization)

getMonetization

@Nullable
public MonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(MonetizationInfoDTO monetization)

rateLimitCount

public SubscriptionThrottlePolicyAllOfDTO rateLimitCount(Integer rateLimitCount)

getRateLimitCount

@Nullable
public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public SubscriptionThrottlePolicyAllOfDTO rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

@Nullable
public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

customAttributes

public SubscriptionThrottlePolicyAllOfDTO 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 SubscriptionThrottlePolicyAllOfDTO 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 SubscriptionThrottlePolicyAllOfDTO 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 SubscriptionThrottlePolicyAllOfDTO permissions(SubscriptionThrottlePolicyPermissionDTO permissions)

getPermissions

@Nullable
public SubscriptionThrottlePolicyPermissionDTO getPermissions()

Get permissions

Returns:

permissions

setPermissions

public void setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)

subscriberCount

public SubscriptionThrottlePolicyAllOfDTO 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 Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object