Package com.mypurecloud.sdk.v2.model

Class GetRulesQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.GetRulesQuery

All Implemented Interfaces:

Serializable

public class GetRulesQuery
extends Object
implements Serializable

GetRulesQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GetRulesQuery.EnabledTypeEnum	The state of the rule the query will return.
static enum	GetRulesQuery.NameSearchTypeEnum	Specifies how strict the name search needs to be.
static enum	GetRulesQuery.QueryTypeEnum	The type of query being performed.
static enum	GetRulesQuery.RuleTypeEnum	The rule type of the alerts the query will return
static enum	GetRulesQuery.SortByEnum	The field to sort responses by.
static enum	GetRulesQuery.SortOrderEnum	The order in which response will be sorted.

Constructor Summary

Constructors

Constructor	Description
GetRulesQuery()
GetRulesQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
GetRulesQuery	enabledType(GetRulesQuery.EnabledTypeEnum enabledType)	The state of the rule the query will return.
boolean	equals(Object o)
GetRulesQuery.EnabledTypeEnum	getEnabledType()
GetRulesQuery.NameSearchTypeEnum	getNameSearchType()
Integer	getPageNumber()
Integer	getPageSize()
GetRulesQuery.QueryTypeEnum	getQueryType()
String	getRuleName()
GetRulesQuery.RuleTypeEnum	getRuleType()
GetRulesQuery.SortByEnum	getSortBy()
GetRulesQuery.SortOrderEnum	getSortOrder()
int	hashCode()
GetRulesQuery	nameSearchType(GetRulesQuery.NameSearchTypeEnum nameSearchType)	Specifies how strict the name search needs to be.
GetRulesQuery	pageNumber(Integer pageNumber)	The page number of the queried response
GetRulesQuery	pageSize(Integer pageSize)	The number of entities to return of the queried response.
GetRulesQuery	queryType(GetRulesQuery.QueryTypeEnum queryType)	The type of query being performed.
GetRulesQuery	ruleName(String ruleName)	The name of the rule being queries.
GetRulesQuery	ruleType(GetRulesQuery.RuleTypeEnum ruleType)	The rule type of the alerts the query will return
void	setEnabledType(GetRulesQuery.EnabledTypeEnum enabledType)
void	setNameSearchType(GetRulesQuery.NameSearchTypeEnum nameSearchType)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQueryType(GetRulesQuery.QueryTypeEnum queryType)
void	setRuleName(String ruleName)
void	setRuleType(GetRulesQuery.RuleTypeEnum ruleType)
void	setSortBy(GetRulesQuery.SortByEnum sortBy)
void	setSortOrder(GetRulesQuery.SortOrderEnum sortOrder)
GetRulesQuery	sortBy(GetRulesQuery.SortByEnum sortBy)	The field to sort responses by.
GetRulesQuery	sortOrder(GetRulesQuery.SortOrderEnum sortOrder)	The order in which response will be sorted.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

GetRulesQuery

public GetRulesQuery()

GetRulesQuery

public GetRulesQuery(Boolean initWithEmptyList)

Method Details

ruleType

public GetRulesQuery ruleType(GetRulesQuery.RuleTypeEnum ruleType)

The rule type of the alerts the query will return

getRuleType

public GetRulesQuery.RuleTypeEnum getRuleType()

setRuleType

public void setRuleType(GetRulesQuery.RuleTypeEnum ruleType)

queryType

public GetRulesQuery queryType(GetRulesQuery.QueryTypeEnum queryType)

The type of query being performed.

getQueryType

public GetRulesQuery.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(GetRulesQuery.QueryTypeEnum queryType)

enabledType

public GetRulesQuery enabledType(GetRulesQuery.EnabledTypeEnum enabledType)

The state of the rule the query will return. The accepted choices are Enabled, Disabled, or All

getEnabledType

public GetRulesQuery.EnabledTypeEnum getEnabledType()

setEnabledType

public void setEnabledType(GetRulesQuery.EnabledTypeEnum enabledType)

pageNumber

public GetRulesQuery pageNumber(Integer pageNumber)

The page number of the queried response

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

pageSize

public GetRulesQuery pageSize(Integer pageSize)

The number of entities to return of the queried response. The max is 25

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

sortBy

public GetRulesQuery sortBy(GetRulesQuery.SortByEnum sortBy)

The field to sort responses by. The accepted choices are Name and DateStart

getSortBy

public GetRulesQuery.SortByEnum getSortBy()

setSortBy

public void setSortBy(GetRulesQuery.SortByEnum sortBy)

sortOrder

public GetRulesQuery sortOrder(GetRulesQuery.SortOrderEnum sortOrder)

The order in which response will be sorted. The accepted choices are Asc and Desc

getSortOrder

public GetRulesQuery.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(GetRulesQuery.SortOrderEnum sortOrder)

ruleName

public GetRulesQuery ruleName(String ruleName)

The name of the rule being queries.

getRuleName

public String getRuleName()

setRuleName

public void setRuleName(String ruleName)

nameSearchType

public GetRulesQuery nameSearchType(GetRulesQuery.NameSearchTypeEnum nameSearchType)

Specifies how strict the name search needs to be. Expected values are Exact and Contains if querying by name.

getNameSearchType

public GetRulesQuery.NameSearchTypeEnum getNameSearchType()

setNameSearchType

public void setNameSearchType(GetRulesQuery.NameSearchTypeEnum nameSearchType)

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