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.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static 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, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    PageParams(int from, int size)
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static PageParams
     
    boolean
     
    static PageParams
    fromXContent(org.elasticsearch.xcontent.XContentParser contentParser)
     
    int
     
    int
     
    int
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    void
     

    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
    • DEFAULT_FROM

      public static final int DEFAULT_FROM
      See Also:
    • DEFAULT_SIZE

      public static final int DEFAULT_SIZE
      See Also:
    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<PageParams,Void> PARSER
  • Constructor Details

    • PageParams

      public PageParams(StreamInput in) throws IOException
      Throws:
      IOException
    • PageParams

      public PageParams()
    • PageParams

      public PageParams(int from, int size)
  • Method Details

    • defaultParams

      public static PageParams defaultParams()
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      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:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • fromXContent

      public static PageParams fromXContent(org.elasticsearch.xcontent.XContentParser contentParser)