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:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class PutRoleMappingRequest
extends RequestBase
implements JsonpSerializable

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 JsonpDeserializer<PutRoleMappingRequest>	_DESERIALIZER	Json deserializer for PutRoleMappingRequest
static Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ElasticsearchError>	ENDPOINT	Endpoint "security.put_role_mapping".

Constructor Summary

Constructors

Constructor	Description
PutRoleMappingRequest(PutRoleMappingRequest.Builder builder)
PutRoleMappingRequest(java.util.function.Function<PutRoleMappingRequest.Builder,PutRoleMappingRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	enabled()	API name: enabled
java.util.Map<java.lang.String,JsonData>	metadata()	API name: metadata
java.lang.String	name()	Required - Role-mapping name
jakarta.json.JsonValue	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.
java.util.List<java.lang.String>	roles()	API name: roles
RoleMappingRule	rules()	API name: rules
java.util.List<java.lang.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(DelegatingDeserializer<PutRoleMappingRequest.Builder> op)

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutRoleMappingRequest> _DESERIALIZER

Json deserializer for PutRoleMappingRequest

ENDPOINT

public static final Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ElasticsearchError> ENDPOINT

Endpoint "security.put_role_mapping".

Constructor Details

PutRoleMappingRequest

public PutRoleMappingRequest(PutRoleMappingRequest.Builder builder)

PutRoleMappingRequest

public PutRoleMappingRequest(java.util.function.Function<PutRoleMappingRequest.Builder,PutRoleMappingRequest.Builder> fn)

Method Details

name

public java.lang.String name()

Required - Role-mapping name

API name: name

refresh

@Nullable
public jakarta.json.JsonValue 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

enabled

@Nullable
public java.lang.Boolean enabled()

API name: enabled

metadata

@Nullable
public java.util.Map<java.lang.String,JsonData> metadata()

API name: metadata

roles

@Nullable
public java.util.List<java.lang.String> roles()

API name: roles

rules

@Nullable
public RoleMappingRule rules()

API name: rules

runAs

@Nullable
public java.util.List<java.lang.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(DelegatingDeserializer<PutRoleMappingRequest.Builder> op)