Class IndicesPrivileges
java.lang.Object
co.elastic.clients.elasticsearch.security.IndicesPrivileges
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndicesPrivileges extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndicesPrivileges.Builder
Builder forIndicesPrivileges
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<IndicesPrivileges>
_DESERIALIZER
Json deserializer forIndicesPrivileges
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowRestrictedIndices()
Set totrue
if using wildcard or regular expressions for patterns that cover restricted indices.FieldSecurity
fieldSecurity()
The document fields that the owners of the role have read access to.java.util.List<java.lang.String>
names()
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.static IndicesPrivileges
of(java.util.function.Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)
java.util.List<IndexPrivilege>
privileges()
Required - The index level privileges that owners of the role have on the specified indices.java.util.List<java.lang.String>
query()
A search query that defines the documents the owners of the role have read 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
setupIndicesPrivilegesDeserializer(ObjectDeserializer<IndicesPrivileges.Builder> op)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forIndicesPrivileges
-
-
Method Details
-
of
public static IndicesPrivileges of(java.util.function.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
public final java.util.List<java.lang.String> 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
public final java.util.List<java.lang.String> query()A search query that defines the documents the owners of the role have read 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 java.lang.Boolean 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
-
setupIndicesPrivilegesDeserializer
protected static void setupIndicesPrivilegesDeserializer(ObjectDeserializer<IndicesPrivileges.Builder> op)
-