Class PutRoleRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.PutRoleRequest
- All Implemented Interfaces:
JsonpSerializable
The role management APIs are generally the preferred way to manage roles,
rather than using file-based role management. The create or update roles API
cannot update roles that are defined in roles files.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutRoleRequest>
Json deserializer forPutRoleRequest
static final Endpoint<PutRoleRequest,
PutRoleResponse, ErrorResponse> Endpoint "security.put_role
". -
Method Summary
Modifier and TypeMethodDescriptionfinal List<ApplicationPrivileges>
A list of application privilege entries.cluster()
A list of cluster privileges.global()
An object defining global privileges.final List<IndicesPrivileges>
indices()
A list of indices permissions entries.metadata()
Optional metadata.final String
name()
Required - The name of the role.static PutRoleRequest
final Refresh
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.runAs()
A list of users that the owners of this role can impersonate.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final TransientMetadataConfig
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.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutRoleRequest
-
_ENDPOINT
Endpoint "security.put_role
".
-
-
Method Details
-
of
-
applications
A list of application privilege entries.API name:
applications
-
cluster
A list of cluster privileges. These privileges define the cluster-level actions for users with this role.API name:
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
-
indices
A list of indices permissions entries.API name:
indices
-
metadata
Optional metadata. Within the metadata object, keys that begin with an underscore (_
) are reserved for system use.API name:
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
-
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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutRoleRequestDeserializer
protected static void setupPutRoleRequestDeserializer(ObjectDeserializer<PutRoleRequest.Builder> op)
-