Package co.elastic.clients.elasticsearch.security

Class RemoteIndicesPrivileges.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.RemoteIndicesPrivileges.Builder

All Implemented Interfaces:

WithJson<RemoteIndicesPrivileges.Builder>, ObjectBuilder<RemoteIndicesPrivileges>

Enclosing class:

RemoteIndicesPrivileges

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

Builder for RemoteIndicesPrivileges.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

clusters

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

Required - A list of cluster aliases to which the permissions in this entry apply.

API name: clusters

Adds all elements of list to clusters.

clusters

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

Required - A list of cluster aliases to which the permissions in this entry apply.

API name: clusters

Adds one or more values to clusters.

fieldSecurity

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

privileges

public final RemoteIndicesPrivileges.Builder privileges(IndexPrivilege value,
 IndexPrivilege... values)

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

API name: privileges

Adds one or more enum values to privileges.

query

public final RemoteIndicesPrivileges.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 RemoteIndicesPrivileges.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 RemoteIndicesPrivileges.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 RemoteIndicesPrivileges.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RemoteIndicesPrivileges.Builder>

build

public RemoteIndicesPrivileges build()

Builds a RemoteIndicesPrivileges.

Specified by:

build in interface ObjectBuilder<RemoteIndicesPrivileges>

Throws:

NullPointerException - if some of the required fields are null.