Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.authz.privilege

Class ConfigurableClusterPrivileges.DatasourcePrivileges

java.lang.Object

org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivileges.DatasourcePrivileges

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, ClusterPrivilege, ConfigurableClusterPrivilege

Enclosing class:

ConfigurableClusterPrivileges

public static class ConfigurableClusterPrivileges.DatasourcePrivileges
extends Object
implements ConfigurableClusterPrivilege

Configurable cluster privileges for ES|QL datasource operations under global.data_source in role definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConfigurableClusterPrivileges.DatasourcePrivileges.DatasourcePermissionGroup

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivilege

ConfigurableClusterPrivilege.Category

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	ESQL_DATASOURCE_PRIVILEGE
static final String	PRIVILEGE_CREATE
static final String	PRIVILEGE_DELETE
static final String	PRIVILEGE_MANAGE
static final String	PRIVILEGE_READ
static final String	PRIVILEGE_READ_METADATA
static final String	WRITEABLE_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DatasourcePrivileges(List<ConfigurableClusterPrivileges.DatasourcePrivileges.DatasourcePermissionGroup> groups)

Method Summary

Modifier and Type	Method	Description
ClusterPermission.Builder	buildPermission(ClusterPermission.Builder builder)	Uses ClusterPermission.Builder to add predicate that later can be used to build a ClusterPermission.
static ConfigurableClusterPrivileges.DatasourcePrivileges	createFrom(StreamInput in)
boolean	equals(Object o)
ConfigurableClusterPrivilege.Category	getCategory()	The category under which this privilege should be rendered when output as XContent.
String	getWriteableName()
int	hashCode()
static ConfigurableClusterPrivileges.DatasourcePrivileges	parseArray(XContentParser parser)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).
void	toXContentArrayElements(XContentBuilder builder, ToXContent.Params params)	Writes permission group objects for ConfigurableClusterPrivileges.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params, java.util.Collection<org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivilege>); the caller opens the global.data_source array.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

ESQL_DATASOURCE_PRIVILEGE

public static final TransportVersion ESQL_DATASOURCE_PRIVILEGE

WRITEABLE_NAME

public static final String WRITEABLE_NAME

See Also:

• Constant Field Values

PRIVILEGE_CREATE

public static final String PRIVILEGE_CREATE

See Also:

• Constant Field Values

PRIVILEGE_DELETE

public static final String PRIVILEGE_DELETE

See Also:

• Constant Field Values

PRIVILEGE_READ_METADATA

public static final String PRIVILEGE_READ_METADATA

See Also:

• Constant Field Values

PRIVILEGE_READ

public static final String PRIVILEGE_READ

See Also:

• Constant Field Values

PRIVILEGE_MANAGE

public static final String PRIVILEGE_MANAGE

See Also:

• Constant Field Values

Constructor Details

DatasourcePrivileges

public DatasourcePrivileges(List<ConfigurableClusterPrivileges.DatasourcePrivileges.DatasourcePermissionGroup> groups)

Method Details

parseArray

@Nullable
public static ConfigurableClusterPrivileges.DatasourcePrivileges parseArray(XContentParser parser)
                                                                     throws IOException

Throws:

IOException

toXContentArrayElements

public void toXContentArrayElements(XContentBuilder builder,
 ToXContent.Params params)
                             throws IOException

Writes permission group objects for ConfigurableClusterPrivileges.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params, java.util.Collection<org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivilege>); the caller opens the global.data_source array.

Throws:

IOException

getCategory

public ConfigurableClusterPrivilege.Category getCategory()

Description copied from interface: ConfigurableClusterPrivilege

The category under which this privilege should be rendered when output as XContent.

Specified by:

getCategory in interface ConfigurableClusterPrivilege

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

createFrom

public static ConfigurableClusterPrivileges.DatasourcePrivileges createFrom(StreamInput in)
                                                                     throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Description copied from interface: ConfigurableClusterPrivilege

A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).

Specified by:

toXContent in interface ConfigurableClusterPrivilege

Specified by:

toXContent in interface ToXContent

Throws:

IOException

buildPermission

public ClusterPermission.Builder buildPermission(ClusterPermission.Builder builder)

Description copied from interface: ClusterPrivilege

Uses ClusterPermission.Builder to add predicate that later can be used to build a ClusterPermission.

Specified by:

buildPermission in interface ClusterPrivilege

Parameters:

builder - ClusterPermission.Builder

Returns:

an instance of ClusterPermission.Builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object