Package co.elastic.clients.elasticsearch.security

Class QueryRoleRequest

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

Get roles in a paginated manner. You can optionally filter the results with a query.

See Also:

  • Field Details

  • Method Details

    • of

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

    • from

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

      @Nullable public final RoleQuery query()
      A query to filter which roles 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 roles: name, description, metadata, applications.application, applications.privileges, applications.resources.

      API name: query

    • searchAfter

      public final List<FieldValue> searchAfter()
      Search after definition

      API name: search_after

    • size

      @Nullable public final Integer size()
      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 List<SortOptions> sort()
      All public fields of a role are eligible for sorting. In addition, sort can also be applied to the _doc field to sort by index order.

      API name: sort

    • 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)

    • setupQueryRoleRequestDeserializer

      protected static void setupQueryRoleRequestDeserializer(ObjectDeserializer<QueryRoleRequest.Builder> op)