Package co.elastic.clients.elasticsearch.security

Class IndicesPrivileges

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

  • Field Details

  • Method Details

    • of

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

    • fieldSecurity

      public final List<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<IndexPrivilege> privileges()
      Required - The index level privileges that owners of the role have on the specified indices.

      API name: privileges

    • query

      @Nullable public final Query 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. Use a custom query of type ("template", RoleTemplateScript) for templated queries

      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

    • setupIndicesPrivilegesDeserializer

      protected static void setupIndicesPrivilegesDeserializer(ObjectDeserializer<IndicesPrivileges.Builder> op)