Package org.elasticsearch.client.security

Class QueryApiKeyRequest

java.lang.Object
org.elasticsearch.client.security.QueryApiKeyRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class QueryApiKeyRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

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

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors
    Constructor
    Description
    QueryApiKeyRequest()
     
    QueryApiKeyRequest​(org.elasticsearch.index.query.QueryBuilder queryBuilder, Integer from, Integer size, List<org.elasticsearch.search.sort.FieldSortBuilder> fieldSortBuilders, org.elasticsearch.search.searchafter.SearchAfterBuilder searchAfterBuilder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object o)
     
    QueryApiKeyRequest
    fieldSortBuilders​(List<org.elasticsearch.search.sort.FieldSortBuilder> fieldSortBuilders)
     
    QueryApiKeyRequest
    from​(int from)
     
    List<org.elasticsearch.search.sort.FieldSortBuilder>
    getFieldSortBuilders()
     
    int
    getFrom()
     
    org.elasticsearch.index.query.QueryBuilder
    getQueryBuilder()
     
    org.elasticsearch.search.searchafter.SearchAfterBuilder
    getSearchAfterBuilder()
     
    int
    getSize()
     
    int
    hashCode()
     
    QueryApiKeyRequest
    queryBuilder​(org.elasticsearch.index.query.QueryBuilder queryBuilder)
     
    QueryApiKeyRequest
    searchAfterBuilder​(org.elasticsearch.search.searchafter.SearchAfterBuilder searchAfterBuilder)
     
    QueryApiKeyRequest
    size​(int size)
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    Optional<ValidationException>
    validate()
    Perform validation.

    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

  • Constructor Details

    • QueryApiKeyRequest

      public QueryApiKeyRequest()

    • QueryApiKeyRequest

      public QueryApiKeyRequest​(@Nullable org.elasticsearch.index.query.QueryBuilder queryBuilder, @Nullable Integer from, @Nullable Integer size, @Nullable List<org.elasticsearch.search.sort.FieldSortBuilder> fieldSortBuilders, @Nullable org.elasticsearch.search.searchafter.SearchAfterBuilder searchAfterBuilder)

  • Method Details

    • getQueryBuilder

      public org.elasticsearch.index.query.QueryBuilder getQueryBuilder()

    • getFrom

      public int getFrom()

    • getSize

      public int getSize()

    • getFieldSortBuilders

      public List<org.elasticsearch.search.sort.FieldSortBuilder> getFieldSortBuilders()

    • getSearchAfterBuilder

      public org.elasticsearch.search.searchafter.SearchAfterBuilder getSearchAfterBuilder()

    • queryBuilder

      public QueryApiKeyRequest queryBuilder​(org.elasticsearch.index.query.QueryBuilder queryBuilder)

    • from

      public QueryApiKeyRequest from​(int from)

    • size

      public QueryApiKeyRequest size​(int size)

    • fieldSortBuilders

      public QueryApiKeyRequest fieldSortBuilders​(List<org.elasticsearch.search.sort.FieldSortBuilder> fieldSortBuilders)

    • searchAfterBuilder

      public QueryApiKeyRequest searchAfterBuilder​(org.elasticsearch.search.searchafter.SearchAfterBuilder searchAfterBuilder)

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • validate

      public Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object