Package co.elastic.clients.elasticsearch.security

Class PutRoleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutRoleRequest.Builder>

co.elastic.clients.elasticsearch.security.PutRoleRequest.Builder

All Implemented Interfaces:

WithJson<PutRoleRequest.Builder>, ObjectBuilder<PutRoleRequest>

Enclosing class:

PutRoleRequest

public static class PutRoleRequest.Builder
extends RequestBase.AbstractBuilder<PutRoleRequest.Builder>
implements ObjectBuilder<PutRoleRequest>

Builder for PutRoleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutRoleRequest.Builder	applications(ApplicationPrivileges value, ApplicationPrivileges... values)	A list of application privilege entries.
final PutRoleRequest.Builder	applications(Function<ApplicationPrivileges.Builder,ObjectBuilder<ApplicationPrivileges>> fn)	A list of application privilege entries.
final PutRoleRequest.Builder	applications(List<ApplicationPrivileges> list)	A list of application privilege entries.
PutRoleRequest	build()	Builds a PutRoleRequest.
final PutRoleRequest.Builder	cluster(ClusterPrivilege value, ClusterPrivilege... values)	A list of cluster privileges.
final PutRoleRequest.Builder	cluster(List<ClusterPrivilege> list)	A list of cluster privileges.
final PutRoleRequest.Builder	global(String key, JsonData value)	An object defining global privileges.
final PutRoleRequest.Builder	global(Map<String,JsonData> map)	An object defining global privileges.
final PutRoleRequest.Builder	indices(IndicesPrivileges value, IndicesPrivileges... values)	A list of indices permissions entries.
final PutRoleRequest.Builder	indices(Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)	A list of indices permissions entries.
final PutRoleRequest.Builder	indices(List<IndicesPrivileges> list)	A list of indices permissions entries.
final PutRoleRequest.Builder	metadata(String key, JsonData value)	Optional metadata.
final PutRoleRequest.Builder	metadata(Map<String,JsonData> map)	Optional metadata.
final PutRoleRequest.Builder	name(String value)	Required - The name of the role.
final PutRoleRequest.Builder	refresh(Refresh value)	If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.
final PutRoleRequest.Builder	runAs(String value, String... values)	A list of users that the owners of this role can impersonate.
final PutRoleRequest.Builder	runAs(List<String> list)	A list of users that the owners of this role can impersonate.
protected PutRoleRequest.Builder	self()
final PutRoleRequest.Builder	transientMetadata(TransientMetadataConfig value)	Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security.
final PutRoleRequest.Builder	transientMetadata(Function<TransientMetadataConfig.Builder,ObjectBuilder<TransientMetadataConfig>> fn)	Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security.

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

applications

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

A list of application privilege entries.

API name: applications

Adds all elements of list to applications.

applications

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

cluster

public final PutRoleRequest.Builder cluster(List<ClusterPrivilege> list)

A list of cluster privileges. These privileges define the cluster-level actions for users with this role.

API name: cluster

Adds all elements of list to cluster.

cluster

public final PutRoleRequest.Builder cluster(ClusterPrivilege value,
 ClusterPrivilege... values)

A list of cluster privileges. These privileges define the cluster-level actions for users with this role.

API name: cluster

Adds one or more values to cluster.

global

public final PutRoleRequest.Builder global(Map<String,JsonData> map)

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 entries of map to global.

global

public final PutRoleRequest.Builder global(String key,
 JsonData value)

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 an entry to global.

indices

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

A list of indices permissions entries.

API name: indices

Adds all elements of list to indices.

indices

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

metadata

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

Optional metadata. Within the metadata object, keys that begin with an underscore (_) are reserved for system use.

API name: metadata

Adds all entries of map to metadata.

metadata

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

Optional metadata. Within the metadata object, keys that begin with an underscore (_) are reserved for system use.

API name: metadata

Adds an entry to metadata.

name

public final PutRoleRequest.Builder name(String value)

Required - The name of the role.

API name: name

refresh

public final PutRoleRequest.Builder refresh(@Nullable
 Refresh value)

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

API name: refresh

runAs

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

A list of users that the owners of this role can impersonate.

API name: run_as

Adds all elements of list to runAs.

runAs

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

A list of users that the owners of this role can impersonate.

API name: run_as

Adds one or more values to runAs.

transientMetadata

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

Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If enabled is false, the role is ignored, but is still listed in the response from the authenticate API.

API name: transient_metadata

transientMetadata

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

Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If enabled is false, the role is ignored, but is still listed in the response from the authenticate API.

API name: transient_metadata

self

protected PutRoleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutRoleRequest.Builder>

build

public PutRoleRequest build()

Builds a PutRoleRequest.

Specified by:

build in interface ObjectBuilder<PutRoleRequest>

Throws:

NullPointerException - if some of the required fields are null.