Package co.elastic.clients.elasticsearch.security.has_privileges

Class IndexPrivilegesCheck

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

  • Field Details

  • Method Details

    • of

      public static IndexPrivilegesCheck of​(java.util.function.Function<IndexPrivilegesCheck.Builder,​ObjectBuilder<IndexPrivilegesCheck>> fn)

    • names

      public final java.util.List<java.lang.String> names()
      Required - A list of indices.

      API name: names

    • privileges

      public final java.util.List<IndexPrivilege> privileges()
      Required - A list of the privileges that you want to check for the specified indices.

      API name: privileges

    • allowRestrictedIndices

      @Nullable public final java.lang.Boolean allowRestrictedIndices()
      This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices. Implicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false. If restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of 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)

    • setupIndexPrivilegesCheckDeserializer

      protected static void setupIndexPrivilegesCheckDeserializer​(ObjectDeserializer<IndexPrivilegesCheck.Builder> op)