Package co.elastic.clients.elasticsearch.security

Class IndicesPrivileges

java.lang.Object

co.elastic.clients.elasticsearch.security.IndicesPrivileges

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public final class IndicesPrivileges
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndicesPrivileges.Builder	Builder for IndicesPrivileges.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<IndicesPrivileges>	_DESERIALIZER	Json deserializer for IndicesPrivileges

Constructor Summary

Constructors

Constructor	Description
IndicesPrivileges(IndicesPrivileges.Builder builder)
IndicesPrivileges(java.util.function.Function<IndicesPrivileges.Builder,IndicesPrivileges.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowRestrictedIndices()	Set to true 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()	A list of indices (or index name patterns) to which the permissions in this entry apply.
java.util.List<IndexPrivilege>	privileges()	The index level privileges that owners of the role have on the specified indices.
Query	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(DelegatingDeserializer<IndicesPrivileges.Builder> op)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<IndicesPrivileges> _DESERIALIZER

Json deserializer for IndicesPrivileges

Constructor Details

IndicesPrivileges

public IndicesPrivileges(IndicesPrivileges.Builder builder)

IndicesPrivileges

public IndicesPrivileges(java.util.function.Function<IndicesPrivileges.Builder,IndicesPrivileges.Builder> fn)

Method Details

fieldSecurity

@Nullable
public FieldSecurity fieldSecurity()

The document fields that the owners of the role have read access to.

API name: field_security

names

public java.util.List<java.lang.String> names()

A list of indices (or index name patterns) to which the permissions in this entry apply.

API name: names

privileges

public java.util.List<IndexPrivilege> privileges()

The index level privileges that owners of the role have on the specified indices.

API name: privileges

query

@Nullable
public Query 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 java.lang.Boolean allowRestrictedIndices()

Set to true 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 the names list, Elasticsearch checks privileges against these indices regardless of the value set for 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)

setupIndicesPrivilegesDeserializer

protected static void setupIndicesPrivilegesDeserializer(DelegatingDeserializer<IndicesPrivileges.Builder> op)