Package org.elasticsearch.xpack.esql.datasources.metadata

Class DataSource

java.lang.Object

org.elasticsearch.xpack.esql.datasources.metadata.DataSource

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public final class DataSource
extends Object
implements Writeable, ToXContentObject

Represents a data source definition stored in cluster state. A data source holds connection settings (credentials, endpoints, auth) for an external data provider.

Nested Class Summary

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataSource(String name, String type, String description, Map<String,DataSourceSetting> settings)
DataSource(String name, String type, String description, DataSourceSettings settings)
DataSource(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	description()
boolean	equals(Object o)
static DataSource	fromXContent(XContentParser parser)
int	hashCode()
String	name()
DataSourceSettings	settings()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Emits the in-memory plaintext representation, including secret values as-is.
String	type()
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.ToXContentObject

isFragment

Constructor Details

DataSource

public DataSource(String name,
 String type,
 @Nullable
 String description,
 Map<String,DataSourceSetting> settings)

DataSource

public DataSource(String name,
 String type,
 @Nullable
 String description,
 DataSourceSettings settings)

DataSource

public DataSource(StreamInput in)
           throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

name

public String name()

type

public String type()

description

public String description()

settings

public DataSourceSettings settings()

fromXContent

public static DataSource fromXContent(XContentParser parser)
                               throws IOException

Throws:

IOException

toXContent

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

Emits the in-memory plaintext representation, including secret values as-is. Used for cluster-state persistence (GATEWAY context only) and is not reached from the API or SNAPSHOT contexts because DataSourceMetadata.context() excludes both. Callers producing REST responses should route through DataSourceSettings.toPresentationMap(). See DataSourceSetting for the encryption-boundary contract.

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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