Class UserIndicesPrivileges
java.lang.Object
co.elastic.clients.elasticsearch.security.UserIndicesPrivileges
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class UserIndicesPrivileges extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UserIndicesPrivileges.Builder
Builder forUserIndicesPrivileges
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<UserIndicesPrivileges>
_DESERIALIZER
Json deserializer forUserIndicesPrivileges
-
Method Summary
Modifier and Type Method Description boolean
allowRestrictedIndices()
Required - Set totrue
if using wildcard or regular expressions for patterns that cover restricted indices.java.util.List<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 UserIndicesPrivileges
of(java.util.function.Function<UserIndicesPrivileges.Builder,ObjectBuilder<UserIndicesPrivileges>> fn)
java.util.List<IndexPrivilege>
privileges()
Required - The index level privileges that owners of the role have on the specified indices.java.util.List<Query>
query()
Search queries that define the documents the user has 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
setupUserIndicesPrivilegesDeserializer(ObjectDeserializer<UserIndicesPrivileges.Builder> op)
java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forUserIndicesPrivileges
-
-
Method Details
-
of
public static UserIndicesPrivileges of(java.util.function.Function<UserIndicesPrivileges.Builder,ObjectBuilder<UserIndicesPrivileges>> 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
Search queries that define the documents the user has access to. A document within the specified indices must match these queries 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
public final boolean allowRestrictedIndices()Required - 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
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupUserIndicesPrivilegesDeserializer
protected static void setupUserIndicesPrivilegesDeserializer(ObjectDeserializer<UserIndicesPrivileges.Builder> op)
-