Package co.elasticsearch.enterprisesearch.client.model.response

Class ResponsePage

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.request.Page

co.elasticsearch.enterprisesearch.client.model.response.ResponsePage

All Implemented Interfaces:

Serializable

public class ResponsePage
extends Page
implements Serializable

Represents the Page object withing a response. This contains totalPages and totalResults in addition to the Page object properties

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResponsePage()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Integer	getTotalPages()	Response Value Number representing the total pages of results.
Integer	getTotalResults()	Response Value Number representing the total results across all pages. The values 0 through 9999 are exact counts. The value 10000 is a pseudo keyword representing greater than or equal to 10,000 results.
int	hashCode()
ResponsePage	setTotalPages(Integer totalPages)	Response Value Number representing the total pages of results.
ResponsePage	setTotalResults(Integer totalResults)	Response Value Number representing the total results across all pages. The values 0 through 9999 are exact counts. The value 10000 is a pseudo keyword representing greater than or equal to 10,000 results.
String	toString()

Methods inherited from class co.elasticsearch.enterprisesearch.client.model.request.Page

getCurrent, getSize, setCurrent, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponsePage

public ResponsePage()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Page

hashCode

public int hashCode()

Overrides:

hashCode in class Page

getTotalPages

public Integer getTotalPages()

Response Value
Number representing the total pages of results. Value is 0 when you paginate beyond 10,000 results.

Returns:

the total number of pages

getTotalResults

public Integer getTotalResults()

Response Value
Number representing the total results across all pages.
The values 0 through 9999 are exact counts.
The value 10000 is a pseudo keyword representing greater than or equal to 10,000 results.

Returns:

the total number of results

setTotalPages

public ResponsePage setTotalPages(Integer totalPages)

Response Value
Number representing the total pages of results. Value is 0 when you paginate beyond 10,000 results.

Parameters:

totalPages - The total number of pages

Returns:

this.

setTotalResults

public ResponsePage setTotalResults(Integer totalResults)

Response Value
Number representing the total results across all pages.
The values 0 through 9999 are exact counts.
The value 10000 is a pseudo keyword representing greater than or equal to 10,000 results.

Parameters:

totalResults - The total number of results

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object