Package com.mypurecloud.sdk.v2.model

Class SearchAggregation

java.lang.Object

com.mypurecloud.sdk.v2.model.SearchAggregation

All Implemented Interfaces:

Serializable

public class SearchAggregation
extends Object
implements Serializable

SearchAggregation

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchAggregation.OrderEnum	Gets or Sets order
static enum	SearchAggregation.TypeEnum	The type of aggregation to perform

Constructor Summary

Constructors

Constructor	Description
SearchAggregation()
SearchAggregation(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SearchAggregation	field(String field)	The field used for aggregation
String	getField()
String	getName()
List<SearchAggregation.OrderEnum>	getOrder()
Integer	getSize()
SearchAggregation.TypeEnum	getType()
String	getValue()
int	hashCode()
SearchAggregation	name(String name)	The name of the aggregation.
SearchAggregation	order(List<SearchAggregation.OrderEnum> order)	The order in which aggregation results are sorted
void	setField(String field)
void	setName(String name)
void	setOrder(List<SearchAggregation.OrderEnum> order)
void	setSize(Integer size)
void	setType(SearchAggregation.TypeEnum type)
void	setValue(String value)
SearchAggregation	size(Integer size)	The number aggregations results to return out of the entire result set
String	toString()
SearchAggregation	type(SearchAggregation.TypeEnum type)	The type of aggregation to perform
SearchAggregation	value(String value)	A value to use for aggregation

Methods inherited from class java.lang.Object

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

Constructor Details

SearchAggregation

public SearchAggregation()

SearchAggregation

public SearchAggregation(Boolean initWithEmptyList)

Method Details

field

public SearchAggregation field(String field)

The field used for aggregation

getField

public String getField()

setField

public void setField(String field)

name

public SearchAggregation name(String name)

The name of the aggregation. The response aggregation uses this name.

getName

public String getName()

setName

public void setName(String name)

type

public SearchAggregation type(SearchAggregation.TypeEnum type)

The type of aggregation to perform

getType

public SearchAggregation.TypeEnum getType()

setType

public void setType(SearchAggregation.TypeEnum type)

value

public SearchAggregation value(String value)

A value to use for aggregation

getValue

public String getValue()

setValue

public void setValue(String value)

size

public SearchAggregation size(Integer size)

The number aggregations results to return out of the entire result set

getSize

public Integer getSize()

setSize

public void setSize(Integer size)

order

public SearchAggregation order(List<SearchAggregation.OrderEnum> order)

The order in which aggregation results are sorted

getOrder

public List<SearchAggregation.OrderEnum> getOrder()

setOrder

public void setOrder(List<SearchAggregation.OrderEnum> order)

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