Package co.elastic.clients.elasticsearch.security

Class SearchAccess

java.lang.Object

co.elastic.clients.elasticsearch.security.SearchAccess

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SearchAccess
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Boolean	allowRestrictedIndices()	Set to true if using wildcard or regular expressions for patterns that cover restricted indices.
final FieldSecurity	fieldSecurity()	The document fields that the owners of the role have read access to.
final List<String>	names()	Required - A list of indices (or index name patterns) to which the permissions in this entry apply.
static SearchAccess	of(Function<SearchAccess.Builder,ObjectBuilder<SearchAccess>> fn)
final IndicesPrivilegesQuery	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	setupSearchAccessDeserializer(ObjectDeserializer<SearchAccess.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SearchAccess> _DESERIALIZER

Json deserializer for SearchAccess

Method Details

of

public static SearchAccess of(Function<SearchAccess.Builder,ObjectBuilder<SearchAccess>> fn)

fieldSecurity

@Nullable
public final FieldSecurity fieldSecurity()

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

API name: field_security

names

public final List<String> names()

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

API name: names

query

@Nullable
public final IndicesPrivilegesQuery 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.

API name: query

allowRestrictedIndices

@Nullable
public final 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)

toString

public String toString()

Overrides:

toString in class Object

setupSearchAccessDeserializer

protected static void setupSearchAccessDeserializer(ObjectDeserializer<SearchAccess.Builder> op)