Package org.elasticsearch.client.core
Class PageParams
java.lang.Object
org.elasticsearch.client.core.PageParams
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
Paging parameters for GET requests
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<PageParams,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
PAGE
public static final org.elasticsearch.xcontent.ParseField PAGE -
FROM
public static final org.elasticsearch.xcontent.ParseField FROM -
SIZE
public static final org.elasticsearch.xcontent.ParseField SIZE -
PARSER
-
-
Constructor Details
-
PageParams
Constructs paging parameters- Parameters:
from
- skips the specified number of items. Whennull
the default value will be used.size
- specifies the maximum number of items to obtain. Whennull
the default value will be used.
-
-
Method Details
-
getFrom
-
getSize
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-