Package co.elastic.clients.elasticsearch.security

Class RoleDescriptor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.security.RoleDescriptor.Builder

All Implemented Interfaces:

WithJson<RoleDescriptor.Builder>, ObjectBuilder<RoleDescriptor>

Enclosing class:

RoleDescriptor

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

Builder for RoleDescriptor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 RoleDescriptor.Builder cluster(String value,
 String... values)

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 RoleDescriptor.Builder indices(List<IndicesPrivileges> list)

A list of indices permissions entries.

API name: indices

Adds all elements of list to indices.

indices

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

A list of indices permissions entries.

API name: indices

Adds one or more values to indices.

indices

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

A list of indices permissions entries.

API name: indices

Adds a value to indices using a builder lambda.

global

public final RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.Builder applications(List<ApplicationPrivileges> list)

A list of application privilege entries

API name: applications

Adds all elements of list to applications.

applications

public final RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.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 RoleDescriptor.Builder transientMetadata(@Nullable
 TransientMetadataConfig value)

API name: transient_metadata

transientMetadata

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

API name: transient_metadata

self

protected RoleDescriptor.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RoleDescriptor.Builder>

build

public RoleDescriptor build()

Builds a RoleDescriptor.

Specified by:

build in interface ObjectBuilder<RoleDescriptor>

Throws:

NullPointerException - if some of the required fields are null.