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

Class DataSourceSettings

java.lang.Object

org.elasticsearch.xpack.esql.datasources.metadata.DataSourceSettings

All Implemented Interfaces:

Iterable<Map.Entry<String,DataSourceSetting>>, Writeable

public final class DataSourceSettings
extends Object
implements Writeable, Iterable<Map.Entry<String,DataSourceSetting>>

Immutable collection of DataSourceSetting keyed by name; pre-computes hasSecrets().

Nested Class Summary

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 DataSourceSettings	EMPTY

Constructor Summary

Constructors

Constructor	Description
DataSourceSettings(Map<String,DataSourceSetting> source)
DataSourceSettings(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Map<String,DataSourceSetting>	asMap()
Set<Map.Entry<String,DataSourceSetting>>	entries()
boolean	equals(Object o)
DataSourceSetting	get(String key)
int	hashCode()
boolean	hasSecrets()	True iff at least one setting is a secret with a non-null value.
boolean	isEmpty()
Iterator<Map.Entry<String,DataSourceSetting>>	iterator()
Set<String>	keys()
int	size()
Map<String,Object>	toPresentationMap()	Returns a fresh map keyed identically to this collection but with secret values replaced by DataSourceSetting.MASK_SENTINEL.
Collection<DataSourceSetting>	values()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EMPTY

public static final DataSourceSettings EMPTY

Constructor Details

DataSourceSettings

public DataSourceSettings(Map<String,DataSourceSetting> source)

DataSourceSettings

public DataSourceSettings(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

get

public DataSourceSetting get(String key)

keys

public Set<String> keys()

values

public Collection<DataSourceSetting> values()

entries

public Set<Map.Entry<String,DataSourceSetting>> entries()

asMap

public Map<String,DataSourceSetting> asMap()

isEmpty

public boolean isEmpty()

size

public int size()

hasSecrets

public boolean hasSecrets()

True iff at least one setting is a secret with a non-null value.

toPresentationMap

public Map<String,Object> toPresentationMap()

Returns a fresh map keyed identically to this collection but with secret values replaced by DataSourceSetting.MASK_SENTINEL. Safe for REST responses.

iterator

public Iterator<Map.Entry<String,DataSourceSetting>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,DataSourceSetting>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object