Class IndexPrivilegesCheck
java.lang.Object
co.elastic.clients.elasticsearch.security.has_privileges.IndexPrivilegesCheck
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<IndexPrivilegesCheck>
Json deserializer forIndexPrivilegesCheck
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices.names()
Required - A list of indices.static IndexPrivilegesCheck
Required - A list of the privileges that you want to check for the specified indices.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
toString()
-
Field Details
-
_DESERIALIZER
Json deserializer forIndexPrivilegesCheck
-
-
Method Details
-
of
public static IndexPrivilegesCheck of(Function<IndexPrivilegesCheck.Builder, ObjectBuilder<IndexPrivilegesCheck>> fn) -
names
Required - A list of indices.API name:
names
-
privileges
Required - A list of the privileges that you want to check for the specified indices.API name:
privileges
-
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupIndexPrivilegesCheckDeserializer
protected static void setupIndexPrivilegesCheckDeserializer(ObjectDeserializer<IndexPrivilegesCheck.Builder> op)
-