Package org.wso2.am.integration.clients.publisher.api.v1.dto

Class ThrottlingPolicyDTO

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.dto.ThrottlingPolicyDTO

public class ThrottlingPolicyDTO
extends Object

ThrottlingPolicyDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ThrottlingPolicyDTO.PolicyLevelEnum	Gets or Sets policyLevel
static enum	ThrottlingPolicyDTO.QuotaPolicyTypeEnum	Default quota limit type
static enum	ThrottlingPolicyDTO.TierPlanEnum	This attribute declares whether this policy is available under commercial or free

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_ATTRIBUTES
static final String	SERIALIZED_NAME_DATA_UNIT
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DISPLAY_NAME
static final String	SERIALIZED_NAME_MONETIZATION_PROPERTIES
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_POLICY_LEVEL
static final String	SERIALIZED_NAME_QUOTA_POLICY_TYPE
static final String	SERIALIZED_NAME_RATE_LIMIT_COUNT
static final String	SERIALIZED_NAME_RATE_LIMIT_TIME_UNIT
static final String	SERIALIZED_NAME_REQUEST_COUNT
static final String	SERIALIZED_NAME_STOP_ON_QUOTA_REACH
static final String	SERIALIZED_NAME_TIER_PLAN
static final String	SERIALIZED_NAME_TIME_UNIT
static final String	SERIALIZED_NAME_UNIT_TIME

Constructor Summary

Constructors

Constructor	Description
ThrottlingPolicyDTO()

Method Summary

Modifier and Type	Method	Description
ThrottlingPolicyDTO	attributes(Map<String,String> attributes)
ThrottlingPolicyDTO	dataUnit(String dataUnit)
ThrottlingPolicyDTO	description(String description)
ThrottlingPolicyDTO	displayName(String displayName)
boolean	equals(Object o)
Map<String,String>	getAttributes()	Custom attributes added to the policy policy
String	getDataUnit()	Unit of data allowed to be transfered.
String	getDescription()	Get description
String	getDisplayName()	Get displayName
Map<String,String>	getMonetizationProperties()	Properties of a tier plan which are related to monetization
String	getName()	Get name
ThrottlingPolicyDTO.PolicyLevelEnum	getPolicyLevel()	Get policyLevel
ThrottlingPolicyDTO.QuotaPolicyTypeEnum	getQuotaPolicyType()	Default quota limit type
Integer	getRateLimitCount()	Burst control request count
String	getRateLimitTimeUnit()	Burst control time unit
Long	getRequestCount()	Maximum number of requests which can be sent within a provided unit time
ThrottlingPolicyDTO.TierPlanEnum	getTierPlan()	This attribute declares whether this policy is available under commercial or free
String	getTimeUnit()	Get timeUnit
Long	getUnitTime()	Get unitTime
int	hashCode()
Boolean	isStopOnQuotaReach()	By making this attribute to false, you are capabale of sending requests even if the request count exceeded within a unit time
ThrottlingPolicyDTO	monetizationProperties(Map<String,String> monetizationProperties)
ThrottlingPolicyDTO	name(String name)
ThrottlingPolicyDTO	policyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)
ThrottlingPolicyDTO	quotaPolicyType(ThrottlingPolicyDTO.QuotaPolicyTypeEnum quotaPolicyType)
ThrottlingPolicyDTO	rateLimitCount(Integer rateLimitCount)
ThrottlingPolicyDTO	rateLimitTimeUnit(String rateLimitTimeUnit)
ThrottlingPolicyDTO	requestCount(Long requestCount)
void	setAttributes(Map<String,String> attributes)
void	setDataUnit(String dataUnit)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setMonetizationProperties(Map<String,String> monetizationProperties)
void	setName(String name)
void	setPolicyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)
void	setQuotaPolicyType(ThrottlingPolicyDTO.QuotaPolicyTypeEnum quotaPolicyType)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setRequestCount(Long requestCount)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
void	setTierPlan(ThrottlingPolicyDTO.TierPlanEnum tierPlan)
void	setTimeUnit(String timeUnit)
void	setUnitTime(Long unitTime)
ThrottlingPolicyDTO	stopOnQuotaReach(Boolean stopOnQuotaReach)
ThrottlingPolicyDTO	tierPlan(ThrottlingPolicyDTO.TierPlanEnum tierPlan)
ThrottlingPolicyDTO	timeUnit(String timeUnit)
String	toString()
ThrottlingPolicyDTO	unitTime(Long unitTime)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_POLICY_LEVEL

public static final String SERIALIZED_NAME_POLICY_LEVEL

See Also:

• Constant Field Values

SERIALIZED_NAME_DISPLAY_NAME

public static final String SERIALIZED_NAME_DISPLAY_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_ATTRIBUTES

public static final String SERIALIZED_NAME_ATTRIBUTES

See Also:

• Constant Field Values

SERIALIZED_NAME_REQUEST_COUNT

public static final String SERIALIZED_NAME_REQUEST_COUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA_UNIT

public static final String SERIALIZED_NAME_DATA_UNIT

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIT_TIME

public static final String SERIALIZED_NAME_UNIT_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_TIME_UNIT

public static final String SERIALIZED_NAME_TIME_UNIT

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_QUOTA_POLICY_TYPE

public static final String SERIALIZED_NAME_QUOTA_POLICY_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_TIER_PLAN

public static final String SERIALIZED_NAME_TIER_PLAN

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_MONETIZATION_PROPERTIES

public static final String SERIALIZED_NAME_MONETIZATION_PROPERTIES

See Also:

• Constant Field Values

Constructor Details

ThrottlingPolicyDTO

public ThrottlingPolicyDTO()

Method Details

name

public ThrottlingPolicyDTO name(String name)

getName

public String getName()

Get name

Returns:

name

setName

public void setName(String name)

description

public ThrottlingPolicyDTO description(String description)

getDescription

@Nullable
public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(String description)

policyLevel

public ThrottlingPolicyDTO policyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)

getPolicyLevel

@Nullable
public ThrottlingPolicyDTO.PolicyLevelEnum getPolicyLevel()

Get policyLevel

Returns:

policyLevel

setPolicyLevel

public void setPolicyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)

displayName

public ThrottlingPolicyDTO displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

Get displayName

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

attributes

public ThrottlingPolicyDTO attributes(Map<String,String> attributes)

getAttributes

@Nullable
public Map<String,String> getAttributes()

Custom attributes added to the policy policy

Returns:

attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

requestCount

public ThrottlingPolicyDTO requestCount(Long requestCount)

getRequestCount

public Long getRequestCount()

Maximum number of requests which can be sent within a provided unit time

Returns:

requestCount

setRequestCount

public void setRequestCount(Long requestCount)

dataUnit

public ThrottlingPolicyDTO dataUnit(String dataUnit)

getDataUnit

@Nullable
public String getDataUnit()

Unit of data allowed to be transfered. Allowed values are \"KB\", \"MB\" and \"GB\"

Returns:

dataUnit

setDataUnit

public void setDataUnit(String dataUnit)

unitTime

public ThrottlingPolicyDTO unitTime(Long unitTime)

getUnitTime

public Long getUnitTime()

Get unitTime

Returns:

unitTime

setUnitTime

public void setUnitTime(Long unitTime)

timeUnit

public ThrottlingPolicyDTO timeUnit(String timeUnit)

getTimeUnit

@Nullable
public String getTimeUnit()

Get timeUnit

Returns:

timeUnit

setTimeUnit

public void setTimeUnit(String timeUnit)

rateLimitCount

public ThrottlingPolicyDTO rateLimitCount(Integer rateLimitCount)

getRateLimitCount

@Nullable
public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public ThrottlingPolicyDTO rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

@Nullable
public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

quotaPolicyType

public ThrottlingPolicyDTO quotaPolicyType(ThrottlingPolicyDTO.QuotaPolicyTypeEnum quotaPolicyType)

getQuotaPolicyType

@Nullable
public ThrottlingPolicyDTO.QuotaPolicyTypeEnum getQuotaPolicyType()

Default quota limit type

Returns:

quotaPolicyType

setQuotaPolicyType

public void setQuotaPolicyType(ThrottlingPolicyDTO.QuotaPolicyTypeEnum quotaPolicyType)

tierPlan

public ThrottlingPolicyDTO tierPlan(ThrottlingPolicyDTO.TierPlanEnum tierPlan)

getTierPlan

public ThrottlingPolicyDTO.TierPlanEnum getTierPlan()

This attribute declares whether this policy is available under commercial or free

Returns:

tierPlan

setTierPlan

public void setTierPlan(ThrottlingPolicyDTO.TierPlanEnum tierPlan)

stopOnQuotaReach

public ThrottlingPolicyDTO stopOnQuotaReach(Boolean stopOnQuotaReach)

isStopOnQuotaReach

public Boolean isStopOnQuotaReach()

By making this attribute to false, you are capabale of sending requests even if the request count exceeded within a unit time

Returns:

stopOnQuotaReach

setStopOnQuotaReach

public void setStopOnQuotaReach(Boolean stopOnQuotaReach)

monetizationProperties

public ThrottlingPolicyDTO monetizationProperties(Map<String,String> monetizationProperties)

getMonetizationProperties

@Nullable
public Map<String,String> getMonetizationProperties()

Properties of a tier plan which are related to monetization

Returns:

monetizationProperties

setMonetizationProperties

public void setMonetizationProperties(Map<String,String> monetizationProperties)

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