Package co.elastic.clients.elasticsearch.security.get_role

Class IndicesPrivilegesRead

java.lang.Object
co.elastic.clients.elasticsearch.security.get_role.IndicesPrivilegesRead
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndicesPrivilegesRead extends Object implements JsonpSerializable
Read-side variant of IndicesPrivileges returned by the get role API. Carries the implicitly_granted marker that is set on entries contributed by a registered ImplicitPrivilegesProvider when include_implicit is true.
See Also:

  • Field Details

  • Method Details

    • of

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

    • implicitlyGranted

      @Nullable public final Boolean implicitlyGranted()
      Set to true on entries that were contributed by a registered ImplicitPrivilegesProvider rather than explicitly stored on the role. Only present when the get role API is called with include_implicit=true. The put role API rejects this field, so clients must not echo it back on a GET-then-PUT round-trip.

      API name: implicitly_granted

    • fieldSecurity

      @Nullable public final FieldSecurity fieldSecurity()
      The document fields that the owners of the role have read access to.

      API name: field_security

    • names

      public final List<String> names()
      Required - A list of indices (or index name patterns) to which the permissions in this entry apply.

      API name: names

    • privileges

      public final List<String> privileges()
      Required - The index level privileges that owners of the role have on the specified indices.

      API name: privileges

    • query

      @Nullable public final IndicesPrivilegesQuery query()
      A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.

      API name: query

    • allowRestrictedIndices

      @Nullable public final Boolean allowRestrictedIndices()
      Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices.

      API name: allow_restricted_indices

    • 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

    • rebuild

      public IndicesPrivilegesRead.Builder rebuild()
      Returns:
      New IndicesPrivilegesRead.Builder initialized with field values of this instance

    • setupIndicesPrivilegesReadDeserializer

      protected static void setupIndicesPrivilegesReadDeserializer(ObjectDeserializer<IndicesPrivilegesRead.Builder> op)