Package co.elastic.clients.elasticsearch.security

Class QueryUserRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.QueryUserRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class QueryUserRequest extends RequestBase implements JsonpSerializable
Find users with a query.

Get information for users in a paginated manner. You can optionally filter the results with a query.

NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users.

See Also:

  • Field Details

  • Method Details

    • of

      public static QueryUserRequest of(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)

    • from

      @Nullable public final Integer from()
      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

      @Nullable public final UserQuery query()
      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 List<FieldValue> searchAfter()
      The search after definition

      API name: search_after

    • size

      @Nullable public final Integer size()
      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 List<SortOptions> sort()
      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

    • withProfileUid

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

      API name: with_profile_uid

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupQueryUserRequestDeserializer

      protected static void setupQueryUserRequestDeserializer(ObjectDeserializer<QueryUserRequest.Builder> op)