Package org.wso2.am.integration.clients.admin.api.dto

Class ThrottleConditionDTO

java.lang.Object

org.wso2.am.integration.clients.admin.api.dto.ThrottleConditionDTO

public class ThrottleConditionDTO
extends Object

Conditions used for Throttling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ThrottleConditionDTO.TypeEnum	Type of the throttling condition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_HEADER_CONDITION
static final String	SERIALIZED_NAME_INVERT_CONDITION
static final String	SERIALIZED_NAME_IP_CONDITION
static final String	SERIALIZED_NAME_JWT_CLAIMS_CONDITION
static final String	SERIALIZED_NAME_QUERY_PARAMETER_CONDITION
static final String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
ThrottleConditionDTO()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HeaderConditionDTO	getHeaderCondition()	Get headerCondition
IPConditionDTO	getIpCondition()	Get ipCondition
JWTClaimsConditionDTO	getJwtClaimsCondition()	Get jwtClaimsCondition
QueryParameterConditionDTO	getQueryParameterCondition()	Get queryParameterCondition
ThrottleConditionDTO.TypeEnum	getType()	Type of the throttling condition.
int	hashCode()
ThrottleConditionDTO	headerCondition(HeaderConditionDTO headerCondition)
ThrottleConditionDTO	invertCondition(Boolean invertCondition)
ThrottleConditionDTO	ipCondition(IPConditionDTO ipCondition)
Boolean	isInvertCondition()	Specifies whether inversion of the condition to be matched against the request.
ThrottleConditionDTO	jwtClaimsCondition(JWTClaimsConditionDTO jwtClaimsCondition)
ThrottleConditionDTO	queryParameterCondition(QueryParameterConditionDTO queryParameterCondition)
void	setHeaderCondition(HeaderConditionDTO headerCondition)
void	setInvertCondition(Boolean invertCondition)
void	setIpCondition(IPConditionDTO ipCondition)
void	setJwtClaimsCondition(JWTClaimsConditionDTO jwtClaimsCondition)
void	setQueryParameterCondition(QueryParameterConditionDTO queryParameterCondition)
void	setType(ThrottleConditionDTO.TypeEnum type)
String	toString()
ThrottleConditionDTO	type(ThrottleConditionDTO.TypeEnum type)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_INVERT_CONDITION

public static final String SERIALIZED_NAME_INVERT_CONDITION

See Also:

• Constant Field Values

SERIALIZED_NAME_HEADER_CONDITION

public static final String SERIALIZED_NAME_HEADER_CONDITION

See Also:

• Constant Field Values

SERIALIZED_NAME_IP_CONDITION

public static final String SERIALIZED_NAME_IP_CONDITION

See Also:

• Constant Field Values

SERIALIZED_NAME_JWT_CLAIMS_CONDITION

public static final String SERIALIZED_NAME_JWT_CLAIMS_CONDITION

See Also:

• Constant Field Values

SERIALIZED_NAME_QUERY_PARAMETER_CONDITION

public static final String SERIALIZED_NAME_QUERY_PARAMETER_CONDITION

See Also:

• Constant Field Values

Constructor Details

ThrottleConditionDTO

public ThrottleConditionDTO()

Method Details

type

public ThrottleConditionDTO type(ThrottleConditionDTO.TypeEnum type)

getType

public ThrottleConditionDTO.TypeEnum getType()

Type of the throttling condition. Allowed values are \"HEADERCONDITION\", \"IPCONDITION\", \"JWTCLAIMSCONDITION\" and \"QUERYPARAMETERCONDITION\".

Returns:

type

setType

public void setType(ThrottleConditionDTO.TypeEnum type)

invertCondition

public ThrottleConditionDTO invertCondition(Boolean invertCondition)

isInvertCondition

@Nullable
public Boolean isInvertCondition()

Specifies whether inversion of the condition to be matched against the request. **Note:** When you add conditional groups for advanced throttling policies, this paramater should have the same value ('true' or 'false') for the same type of conditional group.

Returns:

invertCondition

setInvertCondition

public void setInvertCondition(Boolean invertCondition)

headerCondition

public ThrottleConditionDTO headerCondition(HeaderConditionDTO headerCondition)

getHeaderCondition

@Nullable
public HeaderConditionDTO getHeaderCondition()

Get headerCondition

Returns:

headerCondition

setHeaderCondition

public void setHeaderCondition(HeaderConditionDTO headerCondition)

ipCondition

public ThrottleConditionDTO ipCondition(IPConditionDTO ipCondition)

getIpCondition

@Nullable
public IPConditionDTO getIpCondition()

Get ipCondition

Returns:

ipCondition

setIpCondition

public void setIpCondition(IPConditionDTO ipCondition)

jwtClaimsCondition

public ThrottleConditionDTO jwtClaimsCondition(JWTClaimsConditionDTO jwtClaimsCondition)

getJwtClaimsCondition

@Nullable
public JWTClaimsConditionDTO getJwtClaimsCondition()

Get jwtClaimsCondition

Returns:

jwtClaimsCondition

setJwtClaimsCondition

public void setJwtClaimsCondition(JWTClaimsConditionDTO jwtClaimsCondition)

queryParameterCondition

public ThrottleConditionDTO queryParameterCondition(QueryParameterConditionDTO queryParameterCondition)

getQueryParameterCondition

@Nullable
public QueryParameterConditionDTO getQueryParameterCondition()

Get queryParameterCondition

Returns:

queryParameterCondition

setQueryParameterCondition

public void setQueryParameterCondition(QueryParameterConditionDTO queryParameterCondition)

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