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 forPutRoleMappingRequest
.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 forPutRoleMappingRequest
static Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.put_role_mapping
". -
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 namestatic PutRoleMappingRequest
of(java.util.function.Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)
Refresh
refresh()
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
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(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
Json deserializer forPutRoleMappingRequest
-
_ENDPOINT
public static final Endpoint<PutRoleMappingRequest,PutRoleMappingResponse,ErrorResponse> _ENDPOINTEndpoint "security.put_role_mapping
".
-
-
Method Details
-
of
public static PutRoleMappingRequest of(java.util.function.Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn) -
enabled
@Nullable public final java.lang.Boolean enabled()API name:enabled
-
metadata
API name:metadata
-
name
public final java.lang.String name()Required - Role-mapping nameAPI name:
name
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
roles
public final java.util.List<java.lang.String> roles()API name:roles
-
rules
API name:rules
-
runAs
public final java.util.List<java.lang.String> runAs()API name:run_as
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutRoleMappingRequestDeserializer
protected static void setupPutRoleMappingRequestDeserializer(ObjectDeserializer<PutRoleMappingRequest.Builder> op)
-