Package co.elastic.clients.elasticsearch.security

Class PutPrivilegesRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutPrivilegesRequest.Builder>

co.elastic.clients.elasticsearch.security.PutPrivilegesRequest.Builder

All Implemented Interfaces:

WithJson<PutPrivilegesRequest.Builder>, ObjectBuilder<PutPrivilegesRequest>

Enclosing class:

PutPrivilegesRequest

public static class PutPrivilegesRequest.Builder
extends RequestBase.AbstractBuilder<PutPrivilegesRequest.Builder>
implements ObjectBuilder<PutPrivilegesRequest>

Builder for PutPrivilegesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutPrivilegesRequest	build()	Builds a PutPrivilegesRequest.
final PutPrivilegesRequest.Builder	privileges(String key, Map<String,Actions> value)	Required - Request body.
final PutPrivilegesRequest.Builder	privileges(Map<String,Map<String,Actions>> map)	Required - Request body.
final PutPrivilegesRequest.Builder	refresh(Refresh value)	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.
protected PutPrivilegesRequest.Builder	self()
PutPrivilegesRequest.Builder	withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)	Sets additional properties values on this object by reading from a JSON input.

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

refresh

public final PutPrivilegesRequest.Builder refresh(@Nullable
 Refresh value)

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 PutPrivilegesRequest.Builder privileges(Map<String,Map<String,Actions>> map)

Required - Request body.

Adds all entries of map to privileges.

privileges

public final PutPrivilegesRequest.Builder privileges(String key,
 Map<String,Actions> value)

Required - Request body.

Adds an entry to privileges.

withJson

public PutPrivilegesRequest.Builder withJson(jakarta.json.stream.JsonParser parser,
 JsonpMapper mapper)

Description copied from interface: WithJson

Sets additional properties values on this object by reading from a JSON input.

This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.

This low level variant of withJson gives full control on the json parser and object mapper. Most of the time using WithJson.withJson(Reader) and WithJson.withJson(InputStream) will be more convenient.

Specified by:

withJson in interface WithJson<PutPrivilegesRequest.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<PutPrivilegesRequest.Builder>

Parameters:

parser - the JSONP parser

mapper - the JSONP mapper used to deserialize values and nested objects

Returns:

this object

self

protected PutPrivilegesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutPrivilegesRequest.Builder>

build

public PutPrivilegesRequest build()

Builds a PutPrivilegesRequest.

Specified by:

build in interface ObjectBuilder<PutPrivilegesRequest>

Throws:

NullPointerException - if some of the required fields are null.