Package com.mypurecloud.sdk.v2.model

Class DocumentationV2SearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.DocumentationV2SearchRequest

All Implemented Interfaces:

Serializable

public class DocumentationV2SearchRequest
extends Object
implements Serializable

DocumentationV2SearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
DocumentationV2SearchRequest()
DocumentationV2SearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
DocumentationV2SearchRequest	aggregations(List<DocumentationV2SearchAggregation> aggregations)	Aggregation criteria
boolean	equals(Object o)
List<DocumentationV2SearchAggregation>	getAggregations()
Integer	getPageNumber()
Integer	getPageSize()
List<DocumentationV2SearchCriteria>	getQuery()
List<SearchSort>	getSort()
String	getSortBy()
DocumentationV2SearchRequest.SortOrderEnum	getSortOrder()
List<String>	getTypes()
int	hashCode()
DocumentationV2SearchRequest	pageNumber(Integer pageNumber)	The page of resources you want to retrieve
DocumentationV2SearchRequest	pageSize(Integer pageSize)	The number of results per page
DocumentationV2SearchRequest	query(List<DocumentationV2SearchCriteria> query)	The search criteria
void	setAggregations(List<DocumentationV2SearchAggregation> aggregations)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQuery(List<DocumentationV2SearchCriteria> query)
void	setSort(List<SearchSort> sort)
void	setSortBy(String sortBy)
void	setSortOrder(DocumentationV2SearchRequest.SortOrderEnum sortOrder)
void	setTypes(List<String> types)
DocumentationV2SearchRequest	sort(List<SearchSort> sort)	Multi-value sort order, list of multiple sort values
DocumentationV2SearchRequest	sortBy(String sortBy)	The field in the resource that you want to sort the results by
DocumentationV2SearchRequest	sortOrder(DocumentationV2SearchRequest.SortOrderEnum sortOrder)	The sort order for results
String	toString()
DocumentationV2SearchRequest	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

DocumentationV2SearchRequest

public DocumentationV2SearchRequest()

DocumentationV2SearchRequest

public DocumentationV2SearchRequest(Boolean initWithEmptyList)

Method Details

sortOrder

public DocumentationV2SearchRequest sortOrder(DocumentationV2SearchRequest.SortOrderEnum sortOrder)

The sort order for results

getSortOrder

public DocumentationV2SearchRequest.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(DocumentationV2SearchRequest.SortOrderEnum sortOrder)

sortBy

public DocumentationV2SearchRequest 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 DocumentationV2SearchRequest pageSize(Integer pageSize)

The number of results per page

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public DocumentationV2SearchRequest pageNumber(Integer pageNumber)

The page of resources you want to retrieve

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

sort

public DocumentationV2SearchRequest 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)

types

public DocumentationV2SearchRequest types(List<String> types)

Resource domain type to search

getTypes

public List<String> getTypes()

setTypes

public void setTypes(List<String> types)

query

public DocumentationV2SearchRequest query(List<DocumentationV2SearchCriteria> query)

The search criteria

getQuery

public List<DocumentationV2SearchCriteria> getQuery()

setQuery

public void setQuery(List<DocumentationV2SearchCriteria> query)

aggregations

public DocumentationV2SearchRequest aggregations(List<DocumentationV2SearchAggregation> aggregations)

Aggregation criteria

getAggregations

public List<DocumentationV2SearchAggregation> getAggregations()

setAggregations

public void setAggregations(List<DocumentationV2SearchAggregation> 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