Package co.elastic.clients.elasticsearch.security

Class QueryUserRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<QueryUserRequest.Builder>
co.elastic.clients.elasticsearch.security.QueryUserRequest.Builder
All Implemented Interfaces:
WithJson<QueryUserRequest.Builder>, ObjectBuilder<QueryUserRequest>
Enclosing class:
QueryUserRequest
public static class QueryUserRequest.Builder extends RequestBase.AbstractBuilder<QueryUserRequest.Builder> implements ObjectBuilder<QueryUserRequest>
Builder for QueryUserRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • from

      public final QueryUserRequest.Builder from(@Nullable Integer value)
      The starting document offset. It must not be negative. 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 QueryUserRequest.Builder query(@Nullable UserQuery value)
      A query to filter which users to return. If the query parameter is missing, it is equivalent to a match_all query. The query supports a subset of query types, including match_all, bool, term, terms, match, ids, prefix, wildcard, exists, range, and simple_query_string. You can query the following information associated with user: username, roles, enabled, full_name, and email.

      API name: query

    • query

      public final QueryUserRequest.Builder query(Function<UserQuery.Builder,ObjectBuilder<UserQuery>> fn)
      A query to filter which users to return. If the query parameter is missing, it is equivalent to a match_all query. The query supports a subset of query types, including match_all, bool, term, terms, match, ids, prefix, wildcard, exists, range, and simple_query_string. You can query the following information associated with user: username, roles, enabled, full_name, and email.

      API name: query

    • query

      public final QueryUserRequest.Builder query(UserQueryVariant value)
      A query to filter which users to return. If the query parameter is missing, it is equivalent to a match_all query. The query supports a subset of query types, including match_all, bool, term, terms, match, ids, prefix, wildcard, exists, range, and simple_query_string. You can query the following information associated with user: username, roles, enabled, full_name, and email.

      API name: query

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(List<FieldValue> list)
      The search after definition

      API name: search_after

      Adds all elements of list to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(FieldValue value, FieldValue... values)
      The search after definition

      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(String value, String... values)
      The search after definition

      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(long value, long... values)
      The search after definition

      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(double value, double... values)
      The search after definition

      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(boolean value, boolean... values)
      The search after definition

      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final QueryUserRequest.Builder searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)
      The search after definition

      API name: search_after

      Adds a value to searchAfter using a builder lambda.

    • size

      public final QueryUserRequest.Builder size(@Nullable Integer value)
      The number of hits to return. It must not be negative. 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 QueryUserRequest.Builder sort(List<SortOptions> list)
      The sort definition. Fields eligible for sorting are: username, roles, enabled. In addition, sort can also be applied to the _doc field to sort by index order.

      API name: sort

      Adds all elements of list to sort.

    • sort

      public final QueryUserRequest.Builder sort(SortOptions value, SortOptions... values)
      The sort definition. Fields eligible for sorting are: username, roles, enabled. In addition, sort can also be applied to the _doc field to sort by index order.

      API name: sort

      Adds one or more values to sort.

    • sort

      public final QueryUserRequest.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)
      The sort definition. Fields eligible for sorting are: username, roles, enabled. In addition, sort can also be applied to the _doc field to sort by index order.

      API name: sort

      Adds a value to sort using a builder lambda.

    • withProfileUid

      public final QueryUserRequest.Builder withProfileUid(@Nullable Boolean value)
      Determines whether to retrieve the user profile UID, if it exists, for the users.

      API name: with_profile_uid

    • self

      protected QueryUserRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<QueryUserRequest.Builder>

    • build

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