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

Class SubscriptionPolicyAllOfDTO

java.lang.Object

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

Direct Known Subclasses:

SubscriptionPolicyDTO

public class SubscriptionPolicyAllOfDTO
extends Object

SubscriptionPolicyAllOfDTO

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_BILLING_PLAN
static final String	SERIALIZED_NAME_CUSTOM_ATTRIBUTES
static final String	SERIALIZED_NAME_DEFAULT_LIMIT
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DISPLAY_NAME
static final String	SERIALIZED_NAME_IS_DEPLOYED
static final String	SERIALIZED_NAME_PERMISSIONS
static final String	SERIALIZED_NAME_POLICY_ID
static final String	SERIALIZED_NAME_POLICY_NAME
static final String	SERIALIZED_NAME_RATE_LIMIT_COUNT
static final String	SERIALIZED_NAME_RATE_LIMIT_TIME_UNIT
static final String	SERIALIZED_NAME_STOP_ON_QUOTA_REACH
static final String	SERIALIZED_NAME_SUBSCRIBER_COUNT
static final String	SERIALIZED_NAME_TENANT_DOMAIN
static final String	SERIALIZED_NAME_TENANT_ID
static final String	SERIALIZED_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
SubscriptionPolicyAllOfDTO()

Method Summary

Modifier and Type	Method	Description
SubscriptionPolicyAllOfDTO	billingPlan(String billingPlan)
SubscriptionPolicyAllOfDTO	customAttributes(List<CustomAttributeDTO> customAttributes)
SubscriptionPolicyAllOfDTO	defaultLimit(ThrottleLimitDTO defaultLimit)
SubscriptionPolicyAllOfDTO	description(String description)
SubscriptionPolicyAllOfDTO	displayName(String displayName)
boolean	equals(Object o)
String	getBillingPlan()	define whether this is Paid or a Free plan.
List<CustomAttributeDTO>	getCustomAttributes()	Custom attributes added to the Subscription Throttling Policy
ThrottleLimitDTO	getDefaultLimit()	Get defaultLimit
String	getDescription()	Description of the policy
String	getDisplayName()	Display name of the policy
SubscriptionThrottlePolicyPermissionDTO	getPermissions()	Get permissions
Integer	getPolicyId()	Id of policy
String	getPolicyName()	Name of policy
Integer	getRateLimitCount()	Burst control request count
String	getRateLimitTimeUnit()	Burst control time unit
Integer	getSubscriberCount()	Number of subscriptions allowed
String	getTenantDomain()	Throttling policy tenant domain
Integer	getTenantId()	Throttling policy tenant domain id
String	getUuid()	policy uuid
int	hashCode()
SubscriptionPolicyAllOfDTO	isDeployed(Boolean isDeployed)
Boolean	isIsDeployed()	Indicates whether the policy is deployed successfully or not.
Boolean	isStopOnQuotaReach()	This indicates the action to be taken when a user goes beyond the allocated quota.
SubscriptionPolicyAllOfDTO	permissions(SubscriptionThrottlePolicyPermissionDTO permissions)
SubscriptionPolicyAllOfDTO	policyId(Integer policyId)
SubscriptionPolicyAllOfDTO	policyName(String policyName)
SubscriptionPolicyAllOfDTO	rateLimitCount(Integer rateLimitCount)
SubscriptionPolicyAllOfDTO	rateLimitTimeUnit(String rateLimitTimeUnit)
void	setBillingPlan(String billingPlan)
void	setCustomAttributes(List<CustomAttributeDTO> customAttributes)
void	setDefaultLimit(ThrottleLimitDTO defaultLimit)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setIsDeployed(Boolean isDeployed)
void	setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)
void	setPolicyId(Integer policyId)
void	setPolicyName(String policyName)
void	setRateLimitCount(Integer rateLimitCount)
void	setRateLimitTimeUnit(String rateLimitTimeUnit)
void	setStopOnQuotaReach(Boolean stopOnQuotaReach)
void	setSubscriberCount(Integer subscriberCount)
void	setTenantDomain(String tenantDomain)
void	setTenantId(Integer tenantId)
void	setUuid(String uuid)
SubscriptionPolicyAllOfDTO	stopOnQuotaReach(Boolean stopOnQuotaReach)
SubscriptionPolicyAllOfDTO	subscriberCount(Integer subscriberCount)
SubscriptionPolicyAllOfDTO	tenantDomain(String tenantDomain)
SubscriptionPolicyAllOfDTO	tenantId(Integer tenantId)
String	toString()
SubscriptionPolicyAllOfDTO	uuid(String uuid)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_POLICY_ID

public static final String SERIALIZED_NAME_POLICY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_UUID

public static final String SERIALIZED_NAME_UUID

See Also:

• Constant Field Values

SERIALIZED_NAME_POLICY_NAME

public static final String SERIALIZED_NAME_POLICY_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DISPLAY_NAME

public static final String SERIALIZED_NAME_DISPLAY_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_IS_DEPLOYED

public static final String SERIALIZED_NAME_IS_DEPLOYED

See Also:

• Constant Field Values

SERIALIZED_NAME_TENANT_ID

public static final String SERIALIZED_NAME_TENANT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TENANT_DOMAIN

public static final String SERIALIZED_NAME_TENANT_DOMAIN

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_LIMIT

public static final String SERIALIZED_NAME_DEFAULT_LIMIT

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_SUBSCRIBER_COUNT

public static final String SERIALIZED_NAME_SUBSCRIBER_COUNT

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

Constructor Details

SubscriptionPolicyAllOfDTO

public SubscriptionPolicyAllOfDTO()

Method Details

policyId

public SubscriptionPolicyAllOfDTO policyId(Integer policyId)

getPolicyId

@Nullable
public Integer getPolicyId()

Id of policy

Returns:

policyId

setPolicyId

public void setPolicyId(Integer policyId)

uuid

public SubscriptionPolicyAllOfDTO uuid(String uuid)

getUuid

@Nullable
public String getUuid()

policy uuid

Returns:

uuid

setUuid

public void setUuid(String uuid)

policyName

public SubscriptionPolicyAllOfDTO policyName(String policyName)

getPolicyName

@Nullable
public String getPolicyName()

Name of policy

Returns:

policyName

setPolicyName

public void setPolicyName(String policyName)

displayName

public SubscriptionPolicyAllOfDTO displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

Display name of the policy

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

description

public SubscriptionPolicyAllOfDTO description(String description)

getDescription

@Nullable
public String getDescription()

Description of the policy

Returns:

description

setDescription

public void setDescription(String description)

isDeployed

public SubscriptionPolicyAllOfDTO isDeployed(Boolean isDeployed)

isIsDeployed

@Nullable
public Boolean isIsDeployed()

Indicates whether the policy is deployed successfully or not.

Returns:

isDeployed

setIsDeployed

public void setIsDeployed(Boolean isDeployed)

tenantId

public SubscriptionPolicyAllOfDTO tenantId(Integer tenantId)

getTenantId

@Nullable
public Integer getTenantId()

Throttling policy tenant domain id

Returns:

tenantId

setTenantId

public void setTenantId(Integer tenantId)

tenantDomain

public SubscriptionPolicyAllOfDTO tenantDomain(String tenantDomain)

getTenantDomain

@Nullable
public String getTenantDomain()

Throttling policy tenant domain

Returns:

tenantDomain

setTenantDomain

public void setTenantDomain(String tenantDomain)

defaultLimit

public SubscriptionPolicyAllOfDTO defaultLimit(ThrottleLimitDTO defaultLimit)

getDefaultLimit

public ThrottleLimitDTO getDefaultLimit()

Get defaultLimit

Returns:

defaultLimit

setDefaultLimit

public void setDefaultLimit(ThrottleLimitDTO defaultLimit)

rateLimitCount

public SubscriptionPolicyAllOfDTO rateLimitCount(Integer rateLimitCount)

getRateLimitCount

@Nullable
public Integer getRateLimitCount()

Burst control request count

Returns:

rateLimitCount

setRateLimitCount

public void setRateLimitCount(Integer rateLimitCount)

rateLimitTimeUnit

public SubscriptionPolicyAllOfDTO rateLimitTimeUnit(String rateLimitTimeUnit)

getRateLimitTimeUnit

@Nullable
public String getRateLimitTimeUnit()

Burst control time unit

Returns:

rateLimitTimeUnit

setRateLimitTimeUnit

public void setRateLimitTimeUnit(String rateLimitTimeUnit)

subscriberCount

public SubscriptionPolicyAllOfDTO subscriberCount(Integer subscriberCount)

getSubscriberCount

@Nullable
public Integer getSubscriberCount()

Number of subscriptions allowed

Returns:

subscriberCount

setSubscriberCount

public void setSubscriberCount(Integer subscriberCount)

customAttributes

public SubscriptionPolicyAllOfDTO 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 SubscriptionPolicyAllOfDTO 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 SubscriptionPolicyAllOfDTO 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 SubscriptionPolicyAllOfDTO permissions(SubscriptionThrottlePolicyPermissionDTO permissions)

getPermissions

@Nullable
public SubscriptionThrottlePolicyPermissionDTO getPermissions()

Get permissions

Returns:

permissions

setPermissions

public void setPermissions(SubscriptionThrottlePolicyPermissionDTO permissions)

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