Package org.opensearch.client.opensearch.security

Class CreateRoleRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.CreateRoleRequest

All Implemented Interfaces:

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

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

Creates or replaces the specified role.

Nested Class Summary

Nested Classes

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

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<CreateRoleRequest>	_DESERIALIZER	Json deserializer for CreateRoleRequest
static final Endpoint<CreateRoleRequest,CreateRoleResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_role".

Method Summary

Modifier and Type	Method	Description
static CreateRoleRequest.Builder	builder()
final List<String>	clusterPermissions()	API name: cluster_permissions
final String	description()	API name: description
boolean	equals(Object o)
int	hashCode()
final Boolean	hidden()	API name: hidden
final List<IndexPermission>	indexPermissions()	API name: index_permissions
static CreateRoleRequest	of(Function<CreateRoleRequest.Builder,ObjectBuilder<CreateRoleRequest>> fn)
final Boolean	reserved()	API name: reserved
final String	role()	Required - The name of the role to create.
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	setupCreateRoleRequestDeserializer(ObjectDeserializer<CreateRoleRequest.Builder> op)
final Boolean	static_()	API name: static
final List<TenantPermission>	tenantPermissions()	API name: tenant_permissions
CreateRoleRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for CreateRoleRequest

_ENDPOINT

public static final Endpoint<CreateRoleRequest,CreateRoleResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_role".

Method Details

of

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

clusterPermissions

@Nonnull
public final List<String> clusterPermissions()

API name: cluster_permissions

description

@Nullable
public final String description()

API name: description

hidden

@Nullable
public final Boolean hidden()

API name: hidden

indexPermissions

@Nonnull
public final List<IndexPermission> indexPermissions()

API name: index_permissions

reserved

@Nullable
public final Boolean reserved()

API name: reserved

role

@Nonnull
public final String role()

Required - The name of the role to create.

API name: role

static_

@Nullable
public final Boolean static_()

API name: static

tenantPermissions

@Nonnull
public final List<TenantPermission> tenantPermissions()

API name: tenant_permissions

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 CreateRoleRequest.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<CreateRoleRequest.Builder,CreateRoleRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateRoleRequest.Builder builder()

setupCreateRoleRequestDeserializer

protected static void setupCreateRoleRequestDeserializer(ObjectDeserializer<CreateRoleRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object