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

Class DataSourceSetting

java.lang.Object

org.elasticsearch.xpack.esql.datasources.metadata.DataSourceSetting

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public final class DataSourceSetting
extends Object
implements Writeable, ToXContentObject

A data source setting value plus its secret/non-secret classification, stored in cluster state. A non-secret holds its plaintext value; a secret holds an EncryptedData carrier directly (or null), never raw plaintext — value instanceof EncryptedData is the discriminator. Serialization delegates to EncryptedData's own Writeable/ToXContentObject rather than re-encoding the bytes.

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

Modifier and Type	Field	Description
static final String	MASK_SENTINEL

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataSourceSetting(Object value, boolean secret)
DataSourceSetting(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static DataSourceSetting	fromXContent(XContentParser parser)
int	hashCode()
boolean	isEncrypted()	True iff rawValue() is an encrypted carrier rather than plaintext.
Object	nonSecretValue()	Returns the value of a non-secret setting; throws if secret.
Object	presentationValue()	Returns the masked sentinel for set secrets, null for wiped secrets, or the plaintext value for non-secrets.
Object	rawValue()	Raw stored value — an EncryptedData for an encrypted secret, otherwise the plaintext value.
boolean	secret()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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

Field Details

MASK_SENTINEL

public static final String MASK_SENTINEL

See Also:

• Constant Field Values

Constructor Details

DataSourceSetting

public DataSourceSetting(Object value,
 boolean secret)

DataSourceSetting

public DataSourceSetting(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

secret

public boolean secret()

isEncrypted

public boolean isEncrypted()

True iff rawValue() is an encrypted carrier rather than plaintext.

nonSecretValue

public Object nonSecretValue()

Returns the value of a non-secret setting; throws if secret.

rawValue

public Object rawValue()

Raw stored value — an EncryptedData for an encrypted secret, otherwise the plaintext value.

presentationValue

public Object presentationValue()

Returns the masked sentinel for set secrets, null for wiped secrets, or the plaintext value for non-secrets.

fromXContent

public static DataSourceSetting fromXContent(XContentParser parser)
                                      throws IOException

Throws:

IOException

toXContent

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

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