Package co.elastic.clients.elasticsearch.security

Class RemoteUserIndicesPrivileges.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.RemoteUserIndicesPrivileges.Builder

All Implemented Interfaces:

WithJson<RemoteUserIndicesPrivileges.Builder>, ObjectBuilder<RemoteUserIndicesPrivileges>

Enclosing class:

RemoteUserIndicesPrivileges

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

Builder for RemoteUserIndicesPrivileges.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RemoteUserIndicesPrivileges.Builder	allowRestrictedIndices(boolean value)	Required - Set to true if using wildcard or regular expressions for patterns that cover restricted indices.
RemoteUserIndicesPrivileges	build()	Builds a RemoteUserIndicesPrivileges.
final RemoteUserIndicesPrivileges.Builder	clusters(String value, String... values)	Required - API name: clusters
final RemoteUserIndicesPrivileges.Builder	clusters(List<String> list)	Required - API name: clusters
final RemoteUserIndicesPrivileges.Builder	fieldSecurity(FieldSecurity value, FieldSecurity... values)	The document fields that the owners of the role have read access to.
final RemoteUserIndicesPrivileges.Builder	fieldSecurity(Function<FieldSecurity.Builder,ObjectBuilder<FieldSecurity>> fn)	The document fields that the owners of the role have read access to.
final RemoteUserIndicesPrivileges.Builder	fieldSecurity(List<FieldSecurity> list)	The document fields that the owners of the role have read access to.
final RemoteUserIndicesPrivileges.Builder	names(String value, String... values)	Required - A list of indices (or index name patterns) to which the permissions in this entry apply.
final RemoteUserIndicesPrivileges.Builder	names(List<String> list)	Required - A list of indices (or index name patterns) to which the permissions in this entry apply.
final RemoteUserIndicesPrivileges.Builder	privileges(String value, String... values)	Required - The index level privileges that owners of the role have on the specified indices.
final RemoteUserIndicesPrivileges.Builder	privileges(List<String> list)	Required - The index level privileges that owners of the role have on the specified indices.
final RemoteUserIndicesPrivileges.Builder	query(IndicesPrivilegesQuery value, IndicesPrivilegesQuery... values)	Search queries that define the documents the user has access to.
final RemoteUserIndicesPrivileges.Builder	query(Function<IndicesPrivilegesQuery.Builder,ObjectBuilder<IndicesPrivilegesQuery>> fn)	Search queries that define the documents the user has access to.
final RemoteUserIndicesPrivileges.Builder	query(List<IndicesPrivilegesQuery> list)	Search queries that define the documents the user has access to.
protected RemoteUserIndicesPrivileges.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 RemoteUserIndicesPrivileges.Builder fieldSecurity(List<FieldSecurity> list)

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

API name: field_security

Adds all elements of list to fieldSecurity.

fieldSecurity

public final RemoteUserIndicesPrivileges.Builder fieldSecurity(FieldSecurity value,
 FieldSecurity... values)

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

API name: field_security

Adds one or more values to fieldSecurity.

fieldSecurity

public final RemoteUserIndicesPrivileges.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

Adds a value to fieldSecurity using a builder lambda.

names

public final RemoteUserIndicesPrivileges.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 RemoteUserIndicesPrivileges.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.

privileges

public final RemoteUserIndicesPrivileges.Builder privileges(List<String> list)

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

API name: privileges

Adds all elements of list to privileges.

privileges

public final RemoteUserIndicesPrivileges.Builder privileges(String value,
 String... values)

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

API name: privileges

Adds one or more values to privileges.

query

public final RemoteUserIndicesPrivileges.Builder query(List<IndicesPrivilegesQuery> list)

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.

API name: query

Adds all elements of list to query.

query

public final RemoteUserIndicesPrivileges.Builder query(IndicesPrivilegesQuery value,
 IndicesPrivilegesQuery... values)

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.

API name: query

Adds one or more values to query.

query

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

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.

API name: query

Adds a value to query using a builder lambda.

allowRestrictedIndices

public final RemoteUserIndicesPrivileges.Builder allowRestrictedIndices(boolean value)

Required - 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

clusters

public final RemoteUserIndicesPrivileges.Builder clusters(List<String> list)

Required - API name: clusters

Adds all elements of list to clusters.

clusters

public final RemoteUserIndicesPrivileges.Builder clusters(String value,
 String... values)

Required - API name: clusters

Adds one or more values to clusters.

self

protected RemoteUserIndicesPrivileges.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RemoteUserIndicesPrivileges.Builder>

build

public RemoteUserIndicesPrivileges build()

Builds a RemoteUserIndicesPrivileges.

Specified by:

build in interface ObjectBuilder<RemoteUserIndicesPrivileges>

Throws:

NullPointerException - if some of the required fields are null.