Package org.opensearch.client.opensearch.security

Class Role

java.lang.Object

org.opensearch.client.opensearch.security.Role

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Role>	_DESERIALIZER	Json deserializer for Role

Method Summary

Modifier and Type	Method	Description
static Role.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 Role	of(Function<Role.Builder,ObjectBuilder<Role>> fn)
final Boolean	reserved()	API name: reserved
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	setupRoleDeserializer(ObjectDeserializer<Role.Builder> op)
final Boolean	static_()	API name: static
final List<TenantPermission>	tenantPermissions()	API name: tenant_permissions
Role.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for Role

Method Details

of

public static Role of(Function<Role.Builder,ObjectBuilder<Role>> 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

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

Returns:

a new builder instance.

builder

@Nonnull
public static Role.Builder builder()

setupRoleDeserializer

protected static void setupRoleDeserializer(ObjectDeserializer<Role.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object