Class SubscriptionThrottlePolicyDTO
- java.lang.Object
-
- org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO
-
- org.wso2.am.integration.clients.admin.api.dto.SubscriptionThrottlePolicyDTO
-
public class SubscriptionThrottlePolicyDTO extends ThrottlePolicyDTO
SubscriptionThrottlePolicyDTO
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERIALIZED_NAME_BILLING_PLANstatic StringSERIALIZED_NAME_CUSTOM_ATTRIBUTESstatic StringSERIALIZED_NAME_DEFAULT_LIMITstatic StringSERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITYstatic StringSERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTHstatic StringSERIALIZED_NAME_MONETIZATIONstatic StringSERIALIZED_NAME_PERMISSIONSstatic StringSERIALIZED_NAME_RATE_LIMIT_COUNTstatic StringSERIALIZED_NAME_RATE_LIMIT_TIME_UNITstatic StringSERIALIZED_NAME_STOP_ON_QUOTA_REACHstatic StringSERIALIZED_NAME_SUBSCRIBER_COUNT-
Fields inherited from class org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO
SERIALIZED_NAME_DESCRIPTION, SERIALIZED_NAME_DISPLAY_NAME, SERIALIZED_NAME_IS_DEPLOYED, SERIALIZED_NAME_POLICY_ID, SERIALIZED_NAME_POLICY_NAME, SERIALIZED_NAME_TYPE, type
-
-
Constructor Summary
Constructors Constructor Description SubscriptionThrottlePolicyDTO()
-
Method Summary
-
Methods inherited from class org.wso2.am.integration.clients.admin.api.dto.ThrottlePolicyDTO
description, displayName, getDescription, getDisplayName, getPolicyId, getPolicyName, getType, isDeployed, isIsDeployed, policyId, policyName, setDescription, setDisplayName, setIsDeployed, setPolicyId, setPolicyName, setType, type
-
-
-
-
Field Detail
-
SERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITY
public static final String SERIALIZED_NAME_GRAPH_Q_L_MAX_COMPLEXITY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTH
public static final String SERIALIZED_NAME_GRAPH_Q_L_MAX_DEPTH
- See Also:
- Constant Field Values
-
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
-
-
Method Detail
-
graphQLMaxComplexity
public SubscriptionThrottlePolicyDTO graphQLMaxComplexity(Integer graphQLMaxComplexity)
-
getGraphQLMaxComplexity
@Nullable public Integer getGraphQLMaxComplexity()
Maximum Complexity of the GraphQL query- Returns:
- graphQLMaxComplexity
-
setGraphQLMaxComplexity
public void setGraphQLMaxComplexity(Integer graphQLMaxComplexity)
-
graphQLMaxDepth
public SubscriptionThrottlePolicyDTO graphQLMaxDepth(Integer graphQLMaxDepth)
-
getGraphQLMaxDepth
@Nullable public Integer getGraphQLMaxDepth()
Maximum Depth of the GraphQL query- Returns:
- graphQLMaxDepth
-
setGraphQLMaxDepth
public void setGraphQLMaxDepth(Integer graphQLMaxDepth)
-
defaultLimit
public SubscriptionThrottlePolicyDTO defaultLimit(ThrottleLimitDTO defaultLimit)
-
getDefaultLimit
public ThrottleLimitDTO getDefaultLimit()
Get defaultLimit- Returns:
- defaultLimit
-
setDefaultLimit
public void setDefaultLimit(ThrottleLimitDTO defaultLimit)
-
monetization
public SubscriptionThrottlePolicyDTO monetization(MonetizationInfoDTO monetization)
-
getMonetization
@Nullable public MonetizationInfoDTO getMonetization()
Get monetization- Returns:
- monetization
-
setMonetization
public void setMonetization(MonetizationInfoDTO monetization)
-
rateLimitCount
public SubscriptionThrottlePolicyDTO rateLimitCount(Integer rateLimitCount)
-
getRateLimitCount
@Nullable public Integer getRateLimitCount()
Burst control request count- Returns:
- rateLimitCount
-
setRateLimitCount
public void setRateLimitCount(Integer rateLimitCount)
-
rateLimitTimeUnit
public SubscriptionThrottlePolicyDTO rateLimitTimeUnit(String rateLimitTimeUnit)
-
getRateLimitTimeUnit
@Nullable public String getRateLimitTimeUnit()
Burst control time unit- Returns:
- rateLimitTimeUnit
-
setRateLimitTimeUnit
public void setRateLimitTimeUnit(String rateLimitTimeUnit)
-
customAttributes
public SubscriptionThrottlePolicyDTO 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 SubscriptionThrottlePolicyDTO 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 SubscriptionThrottlePolicyDTO 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 SubscriptionThrottlePolicyDTO permissions(SubscriptionThrottlePolicyPermissionDTO permissions)
-
getPermissions
@Nullable public SubscriptionThrottlePolicyPermissionDTO getPermissions()
Get permissions- Returns:
- permissions
-
setPermissions
public void setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)
-
subscriberCount
public SubscriptionThrottlePolicyDTO 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:
equalsin classThrottlePolicyDTO
-
hashCode
public int hashCode()
- Overrides:
hashCodein classThrottlePolicyDTO
-
toString
public String toString()
- Overrides:
toStringin classThrottlePolicyDTO
-
-