Package com.mypurecloud.sdk.v2.model

Class SearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.SearchRequest

All Implemented Interfaces:

Serializable

public class SearchRequest
extends Object
implements Serializable

SearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchRequest.SortOrderEnum	The sort order for results

Constructor Summary

Constructors

Constructor	Description
SearchRequest()
SearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
SearchRequest	aggregations(List<SearchAggregation> aggregations)	Aggregation criteria
boolean	equals(Object o)
SearchRequest	expand(List<String> expand)	Provides more details about a specified resource
List<SearchAggregation>	getAggregations()
List<String>	getExpand()
Integer	getPageNumber()
Integer	getPageSize()
List<SearchCriteria>	getQuery()
List<String>	getReturnFields()
List<SearchSort>	getSort()
String	getSortBy()
SearchRequest.SortOrderEnum	getSortOrder()
List<String>	getTypes()
int	hashCode()
SearchRequest	pageNumber(Integer pageNumber)	The page of resources you want to retrieve
SearchRequest	pageSize(Integer pageSize)	The number of results per page
SearchRequest	query(List<SearchCriteria> query)	The search criteria
SearchRequest	returnFields(List<String> returnFields)	A List of strings.
void	setAggregations(List<SearchAggregation> aggregations)
void	setExpand(List<String> expand)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQuery(List<SearchCriteria> query)
void	setReturnFields(List<String> returnFields)
void	setSort(List<SearchSort> sort)
void	setSortBy(String sortBy)
void	setSortOrder(SearchRequest.SortOrderEnum sortOrder)
void	setTypes(List<String> types)
SearchRequest	sort(List<SearchSort> sort)	Multi-value sort order, list of multiple sort values
SearchRequest	sortBy(String sortBy)	The field in the resource that you want to sort the results by
SearchRequest	sortOrder(SearchRequest.SortOrderEnum sortOrder)	The sort order for results
String	toString()
SearchRequest	types(List<String> types)	Resource domain type to search

Methods inherited from class java.lang.Object

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

Constructor Details

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(Boolean initWithEmptyList)

Method Details

sortOrder

public SearchRequest sortOrder(SearchRequest.SortOrderEnum sortOrder)

The sort order for results

getSortOrder

public SearchRequest.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(SearchRequest.SortOrderEnum sortOrder)

sortBy

public SearchRequest sortBy(String sortBy)

The field in the resource that you want to sort the results by

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

pageSize

public SearchRequest pageSize(Integer pageSize)

The number of results per page

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public SearchRequest pageNumber(Integer pageNumber)

The page of resources you want to retrieve

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

sort

public SearchRequest sort(List<SearchSort> sort)

Multi-value sort order, list of multiple sort values

getSort

public List<SearchSort> getSort()

setSort

public void setSort(List<SearchSort> sort)

returnFields

public SearchRequest returnFields(List<String> returnFields)

A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.

getReturnFields

public List<String> getReturnFields()

setReturnFields

public void setReturnFields(List<String> returnFields)

expand

public SearchRequest expand(List<String> expand)

Provides more details about a specified resource

getExpand

public List<String> getExpand()

setExpand

public void setExpand(List<String> expand)

types

public SearchRequest types(List<String> types)

Resource domain type to search

getTypes

public List<String> getTypes()

setTypes

public void setTypes(List<String> types)

query

public SearchRequest query(List<SearchCriteria> query)

The search criteria

getQuery

public List<SearchCriteria> getQuery()

setQuery

public void setQuery(List<SearchCriteria> query)

aggregations

public SearchRequest aggregations(List<SearchAggregation> aggregations)

Aggregation criteria

getAggregations

public List<SearchAggregation> getAggregations()

setAggregations

public void setAggregations(List<SearchAggregation> aggregations)

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