PutPrivilegesRequest (java-client 7.17.5 API)

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

Adds or updates application privileges.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PutPrivilegesRequest.Builder
Builder for PutPrivilegesRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<PutPrivilegesRequest>`	`_DESERIALIZER`
`static Endpoint<PutPrivilegesRequest,PutPrivilegesResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`security.put_privileges`".

Method Summary

Modifier and Type	Method	Description
`protected static JsonpDeserializer<PutPrivilegesRequest>`	`createPutPrivilegesRequestDeserializer()`
`java.util.Map<java.lang.String,Actions>`	`get(java.lang.String key)`	Get an element of `privileges`.
`static PutPrivilegesRequest`	`of(java.util.function.Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)`
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,Actions>>`	`privileges()`	Required - Request body.
`Refresh`	`refresh()`	If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<PutPrivilegesRequest> _DESERIALIZER
- _ENDPOINT
  
  public static final Endpoint<PutPrivilegesRequest,PutPrivilegesResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "security.put_privileges".
Method Details
- of
  
  public static PutPrivilegesRequest of(java.util.function.Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)
- refresh
  
  @Nullable public final Refresh refresh()
  
  If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.
  API name: refresh
- privileges
  
  public final java.util.Map<java.lang.String,java.util.Map<java.lang.String,Actions>> privileges()
  
  Required - Request body.
- get
  
  @Nullable public final java.util.Map<java.lang.String,Actions> get(java.lang.String key)
  
  Get an element of privileges.
- serialize
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Serialize this value to JSON.
  
  Specified by:
  
  serialize in interface JsonpSerializable
- createPutPrivilegesRequestDeserializer
  
  protected static JsonpDeserializer<PutPrivilegesRequest> createPutPrivilegesRequestDeserializer()