Package co.elastic.clients.elasticsearch.security.get_role

Class IndicesPrivilegesRead.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.get_role.IndicesPrivilegesRead.Builder

All Implemented Interfaces:

WithJson<IndicesPrivilegesRead.Builder>, ObjectBuilder<IndicesPrivilegesRead>

Enclosing class:

IndicesPrivilegesRead

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

Builder for IndicesPrivilegesRead.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

implicitlyGranted

public final IndicesPrivilegesRead.Builder implicitlyGranted(@Nullable
 Boolean value)

Set to true on entries that were contributed by a registered ImplicitPrivilegesProvider rather than explicitly stored on the role. Only present when the get role API is called with include_implicit=true. The put role API rejects this field, so clients must not echo it back on a GET-then-PUT round-trip.

API name: implicitly_granted

fieldSecurity

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

Specified by:

self in class WithJsonObjectBuilderBase<IndicesPrivilegesRead.Builder>

build

public IndicesPrivilegesRead build()

Builds a IndicesPrivilegesRead.

Specified by:

build in interface ObjectBuilder<IndicesPrivilegesRead>

Throws:

NullPointerException - if some of the required fields are null.