Class PutRoleRequest.Builder
- All Implemented Interfaces:
WithJson<PutRoleRequest.Builder>
,ObjectBuilder<PutRoleRequest>
- Enclosing class:
- PutRoleRequest
public static class PutRoleRequest.Builder extends WithJsonObjectBuilderBase<PutRoleRequest.Builder> implements ObjectBuilder<PutRoleRequest>
PutRoleRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PutRoleRequest.Builder
applications(ApplicationPrivileges value, ApplicationPrivileges... values)
A list of application privilege entries.PutRoleRequest.Builder
applications(java.util.function.Function<ApplicationPrivileges.Builder,ObjectBuilder<ApplicationPrivileges>> fn)
A list of application privilege entries.PutRoleRequest.Builder
applications(java.util.List<ApplicationPrivileges> list)
A list of application privilege entries.PutRoleRequest
build()
Builds aPutRoleRequest
.PutRoleRequest.Builder
cluster(ClusterPrivilege value, ClusterPrivilege... values)
A list of cluster privileges.PutRoleRequest.Builder
cluster(java.util.List<ClusterPrivilege> list)
A list of cluster privileges.PutRoleRequest.Builder
global(java.lang.String key, JsonData value)
An object defining global privileges.PutRoleRequest.Builder
global(java.util.Map<java.lang.String,JsonData> map)
An object defining global privileges.PutRoleRequest.Builder
indices(IndicesPrivileges value, IndicesPrivileges... values)
A list of indices permissions entries.PutRoleRequest.Builder
indices(java.util.function.Function<IndicesPrivileges.Builder,ObjectBuilder<IndicesPrivileges>> fn)
A list of indices permissions entries.PutRoleRequest.Builder
indices(java.util.List<IndicesPrivileges> list)
A list of indices permissions entries.PutRoleRequest.Builder
metadata(java.lang.String key, JsonData value)
Optional metadata.PutRoleRequest.Builder
metadata(java.util.Map<java.lang.String,JsonData> map)
Optional metadata.PutRoleRequest.Builder
name(java.lang.String value)
Required - The name of the role.PutRoleRequest.Builder
refresh(Refresh value)
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.PutRoleRequest.Builder
runAs(java.lang.String value, java.lang.String... values)
A list of users that the owners of this role can impersonate.PutRoleRequest.Builder
runAs(java.util.List<java.lang.String> list)
A list of users that the owners of this role can impersonate.protected PutRoleRequest.Builder
self()
PutRoleRequest.Builder
transientMetadata(TransientMetadataConfig value)
Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security.PutRoleRequest.Builder
transientMetadata(java.util.function.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
-
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(java.util.function.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(java.util.function.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 - The name of the role.API 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(java.util.function.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. 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 classWithJsonObjectBuilderBase<PutRoleRequest.Builder>
-
build
Builds aPutRoleRequest
.- Specified by:
build
in interfaceObjectBuilder<PutRoleRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-