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
public class PageParams extends Object implements 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

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    FROM
     
    static final org.elasticsearch.xcontent.ParseField
    PAGE
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<PageParams,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    SIZE
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageParams(Integer from, Integer size)
    Constructs paging parameters

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Integer
    getFrom()
     
    Integer
    getSize()
     
    int
    hashCode()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.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

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

  • Constructor Details

    • PageParams

      public PageParams(@Nullable Integer from, @Nullable 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 Integer getFrom()

    • getSize

      public Integer 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