Package co.elastic.clients.elasticsearch.security

Class RoleDescriptor

java.lang.Object

co.elastic.clients.elasticsearch.security.RoleDescriptor

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RoleDescriptor
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<ApplicationPrivileges>	applications()	A list of application privilege entries
final List<String>	cluster()	A list of cluster privileges.
final List<GlobalPrivilege>	global()	An object defining global privileges.
final List<IndicesPrivileges>	indices()	A list of indices permissions entries.
final Map<String,JsonData>	metadata()	Optional meta-data.
static RoleDescriptor	of(Function<RoleDescriptor.Builder,ObjectBuilder<RoleDescriptor>> fn)
final List<String>	runAs()	A list of users that the API keys can impersonate.
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	setupRoleDescriptorDeserializer(ObjectDeserializer<RoleDescriptor.Builder> op)
String	toString()
final Map<String,JsonData>	transientMetadata()	API name: transient_metadata

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RoleDescriptor> _DESERIALIZER

Json deserializer for RoleDescriptor

Method Details

of

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

cluster

public final List<String> cluster()

A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

API name: cluster

indices

public final List<IndicesPrivileges> indices()

A list of indices permissions entries.

API name: indices

global

public final List<GlobalPrivilege> global()

An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

API name: global

applications

public final List<ApplicationPrivileges> applications()

A list of application privilege entries

API name: applications

metadata

public final Map<String,JsonData> metadata()

Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.

API name: metadata

runAs

public final List<String> runAs()

A list of users that the API keys can impersonate.

API name: run_as

transientMetadata

public final Map<String,JsonData> transientMetadata()

API name: transient_metadata

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)

toString

public String toString()

Overrides:

toString in class Object

setupRoleDescriptorDeserializer

protected static void setupRoleDescriptorDeserializer(ObjectDeserializer<RoleDescriptor.Builder> op)