Package org.elasticsearch.client.core

Class PageParams

java.lang.Object

org.elasticsearch.client.core.PageParams

All Implemented Interfaces:

ToXContent, ToXContentObject

public class PageParams
extends java.lang.Object
implements ToXContentObject

Paging parameters for GET requests

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FROM
static ParseField	PAGE
static ConstructingObjectParser<PageParams,java.lang.Void>	PARSER
static ParseField	SIZE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PageParams(java.lang.Integer from, java.lang.Integer size)	Constructs paging parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getFrom()
java.lang.Integer	getSize()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

PAGE

public static final ParseField PAGE

FROM

public static final ParseField FROM

SIZE

public static final ParseField SIZE

PARSER

public static final ConstructingObjectParser<PageParams,java.lang.Void> PARSER

Constructor Details

PageParams

public PageParams(@Nullable java.lang.Integer from, @Nullable java.lang.Integer size)

Constructs paging parameters

Parameters:

from - skips the specified number of items. When null the default value will be used.

size - specifies the maximum number of items to obtain. When null the default value will be used.

Method Details

getFrom

public java.lang.Integer getFrom()

getSize

public java.lang.Integer getSize()

toXContent

public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object