Package co.elastic.clients.elasticsearch.security

Class PutRoleMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.PutRoleMappingRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutRoleMappingRequest
extends RequestBase
implements JsonpSerializable

Creates and updates role mappings.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutRoleMappingRequest>	_DESERIALIZER	Json deserializer for PutRoleMappingRequest
static final Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.put_role_mapping".

Method Summary

Modifier and Type	Method	Description
final Boolean	enabled()	API name: enabled
final Map<String,JsonData>	metadata()	API name: metadata
final String	name()	Required - Role-mapping name
static PutRoleMappingRequest	of(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> 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 List<String>	roles()	API name: roles
final List<RoleTemplate>	roleTemplates()	API name: role_templates
final RoleMappingRule	rules()	API name: rules
final List<String>	runAs()	API name: run_as
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	setupPutRoleMappingRequestDeserializer(ObjectDeserializer<PutRoleMappingRequest.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<PutRoleMappingRequest> _DESERIALIZER

Json deserializer for PutRoleMappingRequest

_ENDPOINT

public static final Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "security.put_role_mapping".

Method Details

of

public static PutRoleMappingRequest of(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)

enabled

@Nullable
public final Boolean enabled()

API name: enabled

metadata

public final Map<String,JsonData> metadata()

API name: metadata

name

public final String name()

Required - Role-mapping name

API name: name

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

roleTemplates

public final List<RoleTemplate> roleTemplates()

API name: role_templates

roles

public final List<String> roles()

API name: roles

rules

@Nullable
public final RoleMappingRule rules()

API name: rules

runAs

public final List<String> runAs()

API name: run_as

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)

setupPutRoleMappingRequestDeserializer

protected static void setupPutRoleMappingRequestDeserializer(ObjectDeserializer<PutRoleMappingRequest.Builder> op)