java.lang.Object
org.elasticsearch.xpack.core.action.util.PageParams
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public class PageParams
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Writeable
Helper class collecting options for pagination in a search
-
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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ConstructingObjectParser<PageParams, Void> static final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PageParamsbooleanstatic PageParamsfromXContent(org.elasticsearch.xcontent.XContentParser contentParser) intgetFrom()intgetSize()inthashCode()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods 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 -
DEFAULT_FROM
public static final int DEFAULT_FROM- See Also:
-
DEFAULT_SIZE
public static final int DEFAULT_SIZE- See Also:
-
PARSER
-
-
Constructor Details
-
PageParams
- Throws:
IOException
-
PageParams
public PageParams() -
PageParams
public PageParams(int from, int size)
-
-
Method Details
-
defaultParams
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
getFrom
public int getFrom() -
getSize
public int getSize() -
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-
fromXContent
-