Package co.elastic.clients.elasticsearch.security

Class QueryApiKeysRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.security.QueryApiKeysRequest.Builder
All Implemented Interfaces:
ObjectBuilder<QueryApiKeysRequest>
Enclosing class:
QueryApiKeysRequest
public static class QueryApiKeysRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<QueryApiKeysRequest>
Builder for QueryApiKeysRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • from

      public final QueryApiKeysRequest.Builder from​(@Nullable java.lang.Integer value)
      Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

      API name: from

    • query

      public final QueryApiKeysRequest.Builder query​(@Nullable Query value)
      A query to filter which API keys to return. The query supports a subset of query types, including match_all, bool, term, terms, ids, prefix, wildcard, and range. You can query all public information associated with an API key

      API name: query

    • query

      public final QueryApiKeysRequest.Builder query​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      A query to filter which API keys to return. The query supports a subset of query types, including match_all, bool, term, terms, ids, prefix, wildcard, and range. You can query all public information associated with an API key

      API name: query

    • searchAfter

      public final QueryApiKeysRequest.Builder searchAfter​(java.util.List<java.lang.String> list)
      API name: search_after

      Adds all elements of list to searchAfter.

    • searchAfter

      public final QueryApiKeysRequest.Builder searchAfter​(java.lang.String value, java.lang.String... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • size

      public final QueryApiKeysRequest.Builder size​(@Nullable java.lang.Integer value)
      The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

      API name: size

    • sort

      public final QueryApiKeysRequest.Builder sort​(java.util.List<SortOptions> list)
      API name: sort

      Adds all elements of list to sort.

    • sort

      public final QueryApiKeysRequest.Builder sort​(SortOptions value, SortOptions... values)
      API name: sort

      Adds one or more values to sort.

    • sort

      public final QueryApiKeysRequest.Builder sort​(java.util.function.Function<SortOptions.Builder,​ObjectBuilder<SortOptions>> fn)
      API name: sort

      Adds a value to sort using a builder lambda.

    • build

      public QueryApiKeysRequest build()
      Builds a QueryApiKeysRequest.
      Specified by:
      build in interface ObjectBuilder<QueryApiKeysRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.