Package co.elastic.clients.elasticsearch.security

Class BulkPutRoleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.BulkPutRoleRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class BulkPutRoleRequest
extends RequestBase
implements JsonpSerializable

Bulk create or update roles.

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkPutRoleRequest.Builder	Builder for BulkPutRoleRequest.

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 final JsonpDeserializer<BulkPutRoleRequest>	_DESERIALIZER	Json deserializer for BulkPutRoleRequest
static final Endpoint<BulkPutRoleRequest,BulkPutRoleResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.bulk_put_role".

Method Summary

Modifier and Type	Method	Description
static BulkPutRoleRequest	of(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn)
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.
final Map<String,RoleDescriptor>	roles()	Required - A dictionary of role name to RoleDescriptor objects to add or update
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	setupBulkPutRoleRequestDeserializer(ObjectDeserializer<BulkPutRoleRequest.Builder> op)

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<BulkPutRoleRequest> _DESERIALIZER

Json deserializer for BulkPutRoleRequest

_ENDPOINT

public static final Endpoint<BulkPutRoleRequest,BulkPutRoleResponse,ErrorResponse> _ENDPOINT

Endpoint "security.bulk_put_role".

Method Details

of

public static BulkPutRoleRequest of(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> 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

roles

public final Map<String,RoleDescriptor> roles()

Required - A dictionary of role name to RoleDescriptor objects to add or update

API name: roles

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupBulkPutRoleRequestDeserializer

protected static void setupBulkPutRoleRequestDeserializer(ObjectDeserializer<BulkPutRoleRequest.Builder> op)