Package co.elastic.clients.elasticsearch.security

Class QueryRoleResponse

java.lang.Object
co.elastic.clients.elasticsearch.security.QueryRoleResponse
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class QueryRoleResponse extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • total

      public final int total()
      Required - The total number of roles found.

      API name: total

    • count

      public final int count()
      Required - The number of roles returned in the response.

      API name: count

    • roles

      public final List<QueryRole> roles()
      Required - A list of roles that match the query. The returned role format is an extension of the role definition format. It adds the transient_metadata.enabled and the _sort fields. transient_metadata.enabled is set to false in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license. _sort is present when the search query sorts on some field. It contains the array of values that have been used for sorting.

      API name: roles

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupQueryRoleResponseDeserializer

      protected static void setupQueryRoleResponseDeserializer(ObjectDeserializer<QueryRoleResponse.Builder> op)