Package org.opensearch.client.opensearch.security

Class CreateRoleMappingRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.CreateRoleMappingRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CreateRoleMappingRequest.Builder,CreateRoleMappingRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreateRoleMappingRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CreateRoleMappingRequest.Builder,CreateRoleMappingRequest>

Creates or replaces the specified role mapping.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateRoleMappingRequest>	_DESERIALIZER	Json deserializer for CreateRoleMappingRequest
static final Endpoint<CreateRoleMappingRequest,CreateRoleMappingResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_role_mapping".

Method Summary

Modifier and Type	Method	Description
final List<String>	andBackendRoles()	API name: and_backend_roles
final List<String>	backendRoles()	API name: backend_roles
static CreateRoleMappingRequest.Builder	builder()
final String	description()	API name: description
boolean	equals(Object o)
int	hashCode()
final Boolean	hidden()	API name: hidden
final List<String>	hosts()	API name: hosts
static CreateRoleMappingRequest	of(Function<CreateRoleMappingRequest.Builder,ObjectBuilder<CreateRoleMappingRequest>> fn)
final Boolean	reserved()	API name: reserved
final String	role()	Required - The name of the role for which to create a role mapping.
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	setupCreateRoleMappingRequestDeserializer(ObjectDeserializer<CreateRoleMappingRequest.Builder> op)
CreateRoleMappingRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final List<String>	users()	API name: users

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CreateRoleMappingRequest> _DESERIALIZER

Json deserializer for CreateRoleMappingRequest

_ENDPOINT

public static final Endpoint<CreateRoleMappingRequest,CreateRoleMappingResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_role_mapping".

Method Details

of

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

andBackendRoles

@Nonnull
public final List<String> andBackendRoles()

API name: and_backend_roles

backendRoles

@Nonnull
public final List<String> backendRoles()

API name: backend_roles

description

@Nullable
public final String description()

API name: description

hidden

@Nullable
public final Boolean hidden()

API name: hidden

hosts

@Nonnull
public final List<String> hosts()

API name: hosts

reserved

@Nullable
public final Boolean reserved()

API name: reserved

role

@Nonnull
public final String role()

Required - The name of the role for which to create a role mapping.

API name: role

users

@Nonnull
public final List<String> users()

API name: users

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)

toBuilder

@Nonnull
public CreateRoleMappingRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRoleMappingRequest.Builder,CreateRoleMappingRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateRoleMappingRequest.Builder builder()

setupCreateRoleMappingRequestDeserializer

protected static void setupCreateRoleMappingRequestDeserializer(ObjectDeserializer<CreateRoleMappingRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object