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_securitycluster 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 SummaryNested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBaseRequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutPrivilegesRequest>static final Endpoint<PutPrivilegesRequest,PutPrivilegesResponse, ErrorResponse> Endpoint "security.put_privileges".
- 
Method SummaryModifier and TypeMethodDescriptionprotected static JsonpDeserializer<PutPrivilegesRequest>Get an element ofprivileges.static PutPrivilegesRequestRequired - Request body.final Refreshrefresh()Iftrue(the default) then refresh the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsethen do nothing with refreshes.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBasetoString
- 
Field Details- 
_DESERIALIZER
- 
_ENDPOINTEndpoint "security.put_privileges".
 
- 
- 
Method Details- 
ofpublic static PutPrivilegesRequest of(Function<PutPrivilegesRequest.Builder, ObjectBuilder<PutPrivilegesRequest>> fn) 
- 
refreshIftrue(the default) then refresh the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsethen do nothing with refreshes.API name: refresh
- 
privilegesRequired - Request body.
- 
getGet an element ofprivileges.
- 
serializeSerialize this value to JSON.- Specified by:
- serializein interface- JsonpSerializable
 
- 
createPutPrivilegesRequestDeserializer
 
-