Class ThrottlingPolicyDTO
- java.lang.Object
-
- org.wso2.am.integration.clients.store.api.v1.dto.ThrottlingPolicyDTO
-
public class ThrottlingPolicyDTO extends Object
ThrottlingPolicyDTO
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classThrottlingPolicyDTO.PolicyLevelEnumGets or Sets policyLevelstatic classThrottlingPolicyDTO.QuotaPolicyTypeEnumDefault quota limit typestatic classThrottlingPolicyDTO.TierPlanEnumThis attribute declares whether this tier is available under commercial or free
-
Field Summary
Fields Modifier and Type Field Description static StringSERIALIZED_NAME_ATTRIBUTESstatic StringSERIALIZED_NAME_DATA_UNITstatic StringSERIALIZED_NAME_DESCRIPTIONstatic StringSERIALIZED_NAME_MONETIZATION_ATTRIBUTESstatic StringSERIALIZED_NAME_NAMEstatic StringSERIALIZED_NAME_POLICY_LEVELstatic StringSERIALIZED_NAME_QUOTA_POLICY_TYPEstatic StringSERIALIZED_NAME_RATE_LIMIT_COUNTstatic StringSERIALIZED_NAME_RATE_LIMIT_TIME_UNITstatic StringSERIALIZED_NAME_REQUEST_COUNTstatic StringSERIALIZED_NAME_STOP_ON_QUOTA_REACHstatic StringSERIALIZED_NAME_THROTTLING_POLICY_PERMISSIONSstatic StringSERIALIZED_NAME_TIER_PLANstatic StringSERIALIZED_NAME_TIME_UNITstatic StringSERIALIZED_NAME_UNIT_TIME
-
Constructor Summary
Constructors Constructor Description ThrottlingPolicyDTO()
-
Method Summary
-
-
-
Field Detail
-
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_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_ATTRIBUTES
public static final String SERIALIZED_NAME_MONETIZATION_ATTRIBUTES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_THROTTLING_POLICY_PERMISSIONS
public static final String SERIALIZED_NAME_THROTTLING_POLICY_PERMISSIONS
- See Also:
- Constant Field Values
-
-
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)
-
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)
-
attributes
public ThrottlingPolicyDTO attributes(Map<String,String> attributes)
-
getAttributes
@Nullable public Map<String,String> getAttributes()
Custom attributes added to the throttling policy- Returns:
- 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)
-
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 tier 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()
If this attribute is set 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)
-
monetizationAttributes
public ThrottlingPolicyDTO monetizationAttributes(MonetizationInfoDTO monetizationAttributes)
-
getMonetizationAttributes
@Nullable public MonetizationInfoDTO getMonetizationAttributes()
Get monetizationAttributes- Returns:
- monetizationAttributes
-
setMonetizationAttributes
public void setMonetizationAttributes(MonetizationInfoDTO monetizationAttributes)
-
throttlingPolicyPermissions
public ThrottlingPolicyDTO throttlingPolicyPermissions(ThrottlingPolicyPermissionInfoDTO throttlingPolicyPermissions)
-
getThrottlingPolicyPermissions
@Nullable public ThrottlingPolicyPermissionInfoDTO getThrottlingPolicyPermissions()
Get throttlingPolicyPermissions- Returns:
- throttlingPolicyPermissions
-
setThrottlingPolicyPermissions
public void setThrottlingPolicyPermissions(ThrottlingPolicyPermissionInfoDTO throttlingPolicyPermissions)
-
-