Class PutPrivilegesRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.PutPrivilegesRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutPrivilegesRequest
extends RequestBase
implements JsonpSerializable
Create or update application privileges.
To use this API, you must have one of the following privileges:
- The
manage_security
cluster privilege (or a greater privilege such asall
). - The "Manage Application Privileges" global privilege for the application being referenced in the request.
Application names are formed from a prefix, with an optional suffix that conform to the following rules:
- The prefix must begin with a lowercase ASCII letter.
- The prefix must contain only ASCII letters or digits.
- The prefix must be at least 3 characters long.
- If the suffix exists, it must begin with either a dash
-
or_
. - The suffix cannot contain any of the following characters:
\
,/
,*
,?
,"
,<
,>
,|
,,
,*
. - No part of the name can contain whitespace.
Privilege names must begin with a lowercase ASCII letter and must contain
only ASCII letters and digits along with the characters _
,
-
, and .
.
Action names can contain any number of printable ASCII characters and must
contain at least one of the following characters: /
,
*
, :
.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutPrivilegesRequest>
static final Endpoint<PutPrivilegesRequest,
PutPrivilegesResponse, ErrorResponse> Endpoint "security.put_privileges
". -
Method Summary
Modifier and TypeMethodDescriptionprotected static JsonpDeserializer<PutPrivilegesRequest>
Get an element ofprivileges
.static PutPrivilegesRequest
Required - Request body.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.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
-
_ENDPOINT
Endpoint "security.put_privileges
".
-
-
Method Details
-
of
public static PutPrivilegesRequest of(Function<PutPrivilegesRequest.Builder, ObjectBuilder<PutPrivilegesRequest>> fn) -
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
-
privileges
Required - Request body. -
get
Get an element ofprivileges
. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createPutPrivilegesRequestDeserializer
-