Package co.elastic.clients.elasticsearch.security

Class SearchAccess.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SearchAccess.Builder>

co.elastic.clients.elasticsearch.security.SearchAccess.Builder

All Implemented Interfaces:

WithJson<SearchAccess.Builder>, ObjectBuilder<SearchAccess>

Enclosing class:

SearchAccess

public static class SearchAccess.Builder
extends WithJsonObjectBuilderBase<SearchAccess.Builder>
implements ObjectBuilder<SearchAccess>

Builder for SearchAccess.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SearchAccess.Builder	allowRestrictedIndices(Boolean value)	Set to true if using wildcard or regular expressions for patterns that cover restricted indices.
SearchAccess	build()	Builds a SearchAccess.
final SearchAccess.Builder	fieldSecurity(FieldSecurity value)	The document fields that the owners of the role have read access to.
final SearchAccess.Builder	fieldSecurity(Function<FieldSecurity.Builder,ObjectBuilder<FieldSecurity>> fn)	The document fields that the owners of the role have read access to.
final SearchAccess.Builder	names(String value, String... values)	Required - A list of indices (or index name patterns) to which the permissions in this entry apply.
final SearchAccess.Builder	names(List<String> list)	Required - A list of indices (or index name patterns) to which the permissions in this entry apply.
final SearchAccess.Builder	query(IndicesPrivilegesQuery value)	A search query that defines the documents the owners of the role have access to.
final SearchAccess.Builder	query(Function<IndicesPrivilegesQuery.Builder,ObjectBuilder<IndicesPrivilegesQuery>> fn)	A search query that defines the documents the owners of the role have access to.
protected SearchAccess.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

fieldSecurity

public final SearchAccess.Builder fieldSecurity(@Nullable
 FieldSecurity value)

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

API name: field_security

fieldSecurity

public final SearchAccess.Builder fieldSecurity(Function<FieldSecurity.Builder,ObjectBuilder<FieldSecurity>> fn)

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

API name: field_security

names

public final SearchAccess.Builder names(List<String> list)

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

API name: names

Adds all elements of list to names.

names

public final SearchAccess.Builder names(String value,
 String... values)

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

API name: names

Adds one or more values to names.

query

public final SearchAccess.Builder query(@Nullable
 IndicesPrivilegesQuery value)

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

query

public final SearchAccess.Builder query(Function<IndicesPrivilegesQuery.Builder,ObjectBuilder<IndicesPrivilegesQuery>> fn)

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

public final SearchAccess.Builder allowRestrictedIndices(@Nullable
 Boolean value)

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

self

protected SearchAccess.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SearchAccess.Builder>

build

public SearchAccess build()

Builds a SearchAccess.

Specified by:

build in interface ObjectBuilder<SearchAccess>

Throws:

NullPointerException - if some of the required fields are null.