Class IndicesPrivileges
java.lang.Object
co.elastic.clients.elasticsearch.security.IndicesPrivileges
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<IndicesPrivileges>
Json deserializer forIndicesPrivileges
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Set totrue
if using wildcard or regular expressions for patterns that cover restricted indices.final List<FieldSecurity>
The document fields that the owners of the role have read access to.names()
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.static IndicesPrivileges
Required - The index level privileges that owners of the role have on the specified indices.final Query
query()
A search query that defines the documents the owners of the role have access to.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 forIndicesPrivileges
-
-
Method Details
-
of
public static IndicesPrivileges of(Function<IndicesPrivileges.Builder, ObjectBuilder<IndicesPrivileges>> fn) -
fieldSecurity
The document fields that the owners of the role have read access to.API name:
field_security
-
names
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.API name:
names
-
privileges
Required - The index level privileges that owners of the role have on the specified indices.API name:
privileges
-
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 queriesAPI name:
query
-
allowRestrictedIndices
Set totrue
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 thenames
list, Elasticsearch checks privileges against these indices regardless of the value set forallow_restricted_indices
.API name:
allow_restricted_indices
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupIndicesPrivilegesDeserializer
protected static void setupIndicesPrivilegesDeserializer(ObjectDeserializer<IndicesPrivileges.Builder> op)
-