org.wso2.carbon.apimgt.samples.utils.admin.rest.client.model

Class SubscriptionThrottlePolicy

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.admin.rest.client.model.SubscriptionThrottlePolicy

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-11-01T13:06:20.200+05:30")
public class SubscriptionThrottlePolicy
extends Object

SubscriptionThrottlePolicy

Constructor Summary

Constructors

Constructor and Description
SubscriptionThrottlePolicy()

Method Summary

Modifier and Type	Method and Description
SubscriptionThrottlePolicy	addCustomAttributesItem(CustomAttribute customAttributesItem)
SubscriptionThrottlePolicy	billingPlan(String billingPlan)
SubscriptionThrottlePolicy	customAttributes(List<CustomAttribute> customAttributes)
SubscriptionThrottlePolicy	defaultLimit(ThrottleLimit defaultLimit)
SubscriptionThrottlePolicy	description(String description)
SubscriptionThrottlePolicy	displayName(String displayName)
boolean	equals(Object o)
String	getBillingPlan() define whether this is Paid or a Free plan.
List<CustomAttribute>	getCustomAttributes() Custom attributes added to the Subscription Throttling Policy
ThrottleLimit	getDefaultLimit() Get defaultLimit
String	getDescription() Description of the policy
String	getDisplayName() Display name of the policy
Boolean	getIsDeployed() Indicates whether the policy is deployed successfully or not.
String	getPolicyId() Id of policy
String	getPolicyName() Name of policy
Integer	getRateLimitCount() Burst control request count
String	getRateLimitTimeUnit() Burst control time unit
Boolean	getStopOnQuotaReach() This indicates the action to be taken when a user goes beyond the allocated quota.
int	hashCode()
SubscriptionThrottlePolicy	isDeployed(Boolean isDeployed)
SubscriptionThrottlePolicy	policyId(String policyId)
SubscriptionThrottlePolicy	policyName(String policyName)
SubscriptionThrottlePolicy	rateLimitCount(Integer rateLimitCount)
SubscriptionThrottlePolicy	rateLimitTimeUnit(String rateLimitTimeUnit)
void	setBillingPlan(String billingPlan)
void	setCustomAttributes(List<CustomAttribute> customAttributes)
void	setDefaultLimit(ThrottleLimit defaultLimit)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setIsDeployed(Boolean isDeployed)
void	setPolicyId(String policyId)
void	setPolicyName(String policyName)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
SubscriptionThrottlePolicy	stopOnQuotaReach(Boolean stopOnQuotaReach)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionThrottlePolicy

public SubscriptionThrottlePolicy()

Method Detail

policyId

public SubscriptionThrottlePolicy policyId(String policyId)

getPolicyId

public String getPolicyId()

Id of policy

Returns:

policyId

setPolicyId

public void setPolicyId(String policyId)

policyName

public SubscriptionThrottlePolicy policyName(String policyName)

getPolicyName

public String getPolicyName()

Name of policy

Returns:

policyName

setPolicyName

public void setPolicyName(String policyName)

displayName

public SubscriptionThrottlePolicy displayName(String displayName)

getDisplayName

public String getDisplayName()

Display name of the policy

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

description

public SubscriptionThrottlePolicy description(String description)

getDescription

public String getDescription()

Description of the policy

Returns:

description

setDescription

public void setDescription(String description)

isDeployed

public SubscriptionThrottlePolicy isDeployed(Boolean isDeployed)

getIsDeployed

public Boolean getIsDeployed()

Indicates whether the policy is deployed successfully or not.

Returns:

isDeployed

setIsDeployed

public void setIsDeployed(Boolean isDeployed)

defaultLimit

public SubscriptionThrottlePolicy defaultLimit(ThrottleLimit defaultLimit)

getDefaultLimit

public ThrottleLimit getDefaultLimit()

Get defaultLimit

Returns:

defaultLimit

setDefaultLimit

public void setDefaultLimit(ThrottleLimit defaultLimit)

rateLimitCount

public SubscriptionThrottlePolicy rateLimitCount(Integer rateLimitCount)

getRateLimitCount

public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public SubscriptionThrottlePolicy rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

customAttributes

public SubscriptionThrottlePolicy customAttributes(List<CustomAttribute> customAttributes)

addCustomAttributesItem

public SubscriptionThrottlePolicy addCustomAttributesItem(CustomAttribute customAttributesItem)

getCustomAttributes

public List<CustomAttribute> getCustomAttributes()

Custom attributes added to the Subscription Throttling Policy

Returns:

customAttributes

setCustomAttributes

public void setCustomAttributes(List<CustomAttribute> customAttributes)

stopOnQuotaReach

public SubscriptionThrottlePolicy stopOnQuotaReach(Boolean stopOnQuotaReach)

getStopOnQuotaReach

public Boolean getStopOnQuotaReach()

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 SubscriptionThrottlePolicy 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 Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object