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 and Description
static class	ThrottlingPolicyDTO.PolicyLevelEnum Gets or Sets policyLevel
static class	ThrottlingPolicyDTO.TierPlanEnum This attribute declares whether this policy is available under commercial or free

Constructor Summary

Constructors

Constructor and Description
ThrottlingPolicyDTO()

Method Summary

Modifier and Type	Method and Description
ThrottlingPolicyDTO	attributes(Map<String,String> attributes)
ThrottlingPolicyDTO	description(String description)
ThrottlingPolicyDTO	displayName(String displayName)
boolean	equals(Object o)
Map<String,String>	getAttributes() Custom attributes added to the policy policy
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
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	putAttributesItem(String key, String attributesItem)
ThrottlingPolicyDTO	putMonetizationPropertiesItem(String key, String monetizationPropertiesItem)
ThrottlingPolicyDTO	requestCount(Long requestCount)
void	setAttributes(Map<String,String> attributes)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setMonetizationProperties(Map<String,String> monetizationProperties)
void	setName(String name)
void	setPolicyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)
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

Constructor Detail

ThrottlingPolicyDTO

public ThrottlingPolicyDTO()

Method Detail

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

public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(String description)

policyLevel

public ThrottlingPolicyDTO policyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)

getPolicyLevel

public ThrottlingPolicyDTO.PolicyLevelEnum getPolicyLevel()

Get policyLevel

Returns:

policyLevel

setPolicyLevel

public void setPolicyLevel(ThrottlingPolicyDTO.PolicyLevelEnum policyLevel)

displayName

public ThrottlingPolicyDTO displayName(String displayName)

getDisplayName

public String getDisplayName()

Get displayName

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

attributes

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

putAttributesItem

public ThrottlingPolicyDTO putAttributesItem(String key,
                                             String attributesItem)

getAttributes

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)

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

public String getTimeUnit()

Get timeUnit

Returns:

timeUnit

setTimeUnit

public void setTimeUnit(String timeUnit)

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)

putMonetizationPropertiesItem

public ThrottlingPolicyDTO putMonetizationPropertiesItem(String key,
                                                         String monetizationPropertiesItem)

getMonetizationProperties

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