Package co.elastic.clients.elasticsearch.security

Class RoleDescriptorRead.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.RoleDescriptorRead.Builder

All Implemented Interfaces:

WithJson<RoleDescriptorRead.Builder>, ObjectBuilder<RoleDescriptorRead>

Enclosing class:

RoleDescriptorRead

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

Builder for RoleDescriptorRead.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RoleDescriptorRead.Builder	applications(ApplicationPrivileges value, ApplicationPrivileges... values)	A list of application privilege entries
final RoleDescriptorRead.Builder	applications(Function<ApplicationPrivileges.Builder,ObjectBuilder<ApplicationPrivileges>> fn)	A list of application privilege entries
final RoleDescriptorRead.Builder	applications(List<ApplicationPrivileges> list)	A list of application privilege entries
RoleDescriptorRead	build()	Builds a RoleDescriptorRead.
final RoleDescriptorRead.Builder	cluster(String value, String... values)	Required - A list of cluster privileges.
final RoleDescriptorRead.Builder	cluster(List<String> list)	Required - A list of cluster privileges.
final RoleDescriptorRead.Builder	global(GlobalPrivilege value, GlobalPrivilege... values)	An object defining global privileges.
final RoleDescriptorRead.Builder	global(Function<GlobalPrivilege.Builder,ObjectBuilder<GlobalPrivilege>> fn)	An object defining global privileges.
final RoleDescriptorRead.Builder	global(List<GlobalPrivilege> list)	An object defining global privileges.
final RoleDescriptorRead.Builder	indices(IndicesPrivileges value, IndicesPrivileges... values)	Required - A list of indices permissions entries.
final RoleDescriptorRead.Builder	indices(Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)	Required - A list of indices permissions entries.
final RoleDescriptorRead.Builder	indices(List<IndicesPrivileges> list)	Required - A list of indices permissions entries.
final RoleDescriptorRead.Builder	metadata(String key, JsonData value)	Optional meta-data.
final RoleDescriptorRead.Builder	metadata(Map<String,JsonData> map)	Optional meta-data.
final RoleDescriptorRead.Builder	runAs(String value, String... values)	A list of users that the API keys can impersonate.
final RoleDescriptorRead.Builder	runAs(List<String> list)	A list of users that the API keys can impersonate.
protected RoleDescriptorRead.Builder	self()
final RoleDescriptorRead.Builder	transientMetadata(TransientMetadataConfig value)	API name: transient_metadata
final RoleDescriptorRead.Builder	transientMetadata(Function<TransientMetadataConfig.Builder,ObjectBuilder<TransientMetadataConfig>> fn)	API name: transient_metadata

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

cluster

public final RoleDescriptorRead.Builder cluster(List<String> list)

Required - A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

API name: cluster

Adds all elements of list to cluster.

cluster

public final RoleDescriptorRead.Builder cluster(String value,
 String... values)

Required - A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

API name: cluster

Adds one or more values to cluster.

indices

public final RoleDescriptorRead.Builder indices(List<IndicesPrivileges> list)

Required - A list of indices permissions entries.

API name: indices

Adds all elements of list to indices.

indices

public final RoleDescriptorRead.Builder indices(IndicesPrivileges value,
 IndicesPrivileges... values)

Required - A list of indices permissions entries.

API name: indices

Adds one or more values to indices.

indices

public final RoleDescriptorRead.Builder indices(Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)

Required - A list of indices permissions entries.

API name: indices

Adds a value to indices using a builder lambda.

global

public final RoleDescriptorRead.Builder global(List<GlobalPrivilege> list)

An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

API name: global

Adds all elements of list to global.

global

public final RoleDescriptorRead.Builder global(GlobalPrivilege value,
 GlobalPrivilege... values)

An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

API name: global

Adds one or more values to global.

global

public final RoleDescriptorRead.Builder global(Function<GlobalPrivilege.Builder,ObjectBuilder<GlobalPrivilege>> fn)

An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

API name: global

Adds a value to global using a builder lambda.

applications

public final RoleDescriptorRead.Builder applications(List<ApplicationPrivileges> list)

A list of application privilege entries

API name: applications

Adds all elements of list to applications.

applications

public final RoleDescriptorRead.Builder applications(ApplicationPrivileges value,
 ApplicationPrivileges... values)

A list of application privilege entries

API name: applications

Adds one or more values to applications.

applications

public final RoleDescriptorRead.Builder applications(Function<ApplicationPrivileges.Builder,ObjectBuilder<ApplicationPrivileges>> fn)

A list of application privilege entries

API name: applications

Adds a value to applications using a builder lambda.

metadata

public final RoleDescriptorRead.Builder metadata(Map<String,JsonData> map)

Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

API name: metadata

Adds all entries of map to metadata.

metadata

public final RoleDescriptorRead.Builder metadata(String key,
 JsonData value)

Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

API name: metadata

Adds an entry to metadata.

runAs

public final RoleDescriptorRead.Builder runAs(List<String> list)

A list of users that the API keys can impersonate.

API name: run_as

Adds all elements of list to runAs.

runAs

public final RoleDescriptorRead.Builder runAs(String value,
 String... values)

A list of users that the API keys can impersonate.

API name: run_as

Adds one or more values to runAs.

transientMetadata

public final RoleDescriptorRead.Builder transientMetadata(@Nullable
 TransientMetadataConfig value)

API name: transient_metadata

transientMetadata

public final RoleDescriptorRead.Builder transientMetadata(Function<TransientMetadataConfig.Builder,ObjectBuilder<TransientMetadataConfig>> fn)

API name: transient_metadata

self

protected RoleDescriptorRead.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RoleDescriptorRead.Builder>

build

public RoleDescriptorRead build()

Builds a RoleDescriptorRead.

Specified by:

build in interface ObjectBuilder<RoleDescriptorRead>

Throws:

NullPointerException - if some of the required fields are null.