Class PutRoleRequest.Builder
- All Implemented Interfaces:
WithJson<PutRoleRequest.Builder>
,ObjectBuilder<PutRoleRequest>
- Enclosing class:
- PutRoleRequest
PutRoleRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal PutRoleRequest.Builder
applications
(ApplicationPrivileges value, ApplicationPrivileges... values) A list of application privilege entries.final PutRoleRequest.Builder
A list of application privilege entries.final PutRoleRequest.Builder
A list of application privilege entries.build()
Builds aPutRoleRequest
.final PutRoleRequest.Builder
A list of cluster privileges.final PutRoleRequest.Builder
A list of cluster privileges.final PutRoleRequest.Builder
An object defining global privileges.final PutRoleRequest.Builder
An object defining global privileges.final PutRoleRequest.Builder
indices
(IndicesPrivileges value, IndicesPrivileges... values) A list of indices permissions entries.final PutRoleRequest.Builder
A list of indices permissions entries.final PutRoleRequest.Builder
indices
(List<IndicesPrivileges> list) A list of indices permissions entries.final PutRoleRequest.Builder
Optional metadata.final PutRoleRequest.Builder
Optional metadata.final PutRoleRequest.Builder
Required - Role namefinal PutRoleRequest.Builder
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.final PutRoleRequest.Builder
A list of users that the owners of this role can impersonate.final PutRoleRequest.Builder
A list of users that the owners of this role can impersonate.protected PutRoleRequest.Builder
self()
final PutRoleRequest.Builder
Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security.final PutRoleRequest.Builder
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applications
A list of application privilege entries.API name:
applications
Adds all elements of
list
toapplications
. -
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
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
tocluster
. -
cluster
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
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
toglobal
. -
global
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
A list of indices permissions entries.API name:
indices
Adds all elements of
list
toindices
. -
indices
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
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
tometadata
. -
metadata
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
Required - Role nameAPI name:
name
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
runAs
A list of users that the owners of this role can impersonate.API name:
run_as
Adds all elements of
list
torunAs
. -
runAs
A list of users that the owners of this role can impersonate.API name:
run_as
Adds one or more values to
runAs
. -
transientMetadata
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. Ifenabled
isfalse
, 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<TransientMetadata.Builder, ObjectBuilder<TransientMetadata>> 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. Ifenabled
isfalse
, the role is ignored, but is still listed in the response from the authenticate API.API name:
transient_metadata
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutRoleRequest.Builder>
-
build
Builds aPutRoleRequest
.- Specified by:
build
in interfaceObjectBuilder<PutRoleRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-