Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamOptions

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamOptions

All Implemented Interfaces:

Diffable<DataStreamOptions>, SimpleDiffable<DataStreamOptions>, Writeable, ToXContent, ToXContentObject

public record DataStreamOptions(DataStreamFailureStore failureStore)
extends Record
implements SimpleDiffable<DataStreamOptions>, ToXContentObject

Holds data stream dedicated configuration options such as failure store, (in the future lifecycle). Currently, it supports the following configurations: - failure store

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataStreamOptions.Template	This class is only used in template configuration.

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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 DataStreamOptions	EMPTY
static final DataStreamOptions	FAILURE_STORE_DISABLED
static final DataStreamOptions	FAILURE_STORE_ENABLED
static final ParseField	FAILURE_STORE_FIELD
static final ConstructingObjectParser<DataStreamOptions,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataStreamOptions(DataStreamFailureStore failureStore)	Creates an instance of a DataStreamOptions record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
DataStreamFailureStore	failureStore()	Returns the value of the failureStore record component.
static DataStreamOptions	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
static DataStreamOptions	read(StreamInput in)
static Diff<DataStreamOptions>	readDiffFrom(StreamInput in)
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

FAILURE_STORE_FIELD

public static final ParseField FAILURE_STORE_FIELD

FAILURE_STORE_ENABLED

public static final DataStreamOptions FAILURE_STORE_ENABLED

FAILURE_STORE_DISABLED

public static final DataStreamOptions FAILURE_STORE_DISABLED

EMPTY

public static final DataStreamOptions EMPTY

PARSER

public static final ConstructingObjectParser<DataStreamOptions,Void> PARSER

Constructor Details

DataStreamOptions

public DataStreamOptions(@Nullable
 DataStreamFailureStore failureStore)

Creates an instance of a DataStreamOptions record class.

Parameters:

failureStore - the value for the failureStore record component

Method Details

read

public static DataStreamOptions read(StreamInput in)
                              throws IOException

Throws:

IOException

readDiffFrom

public static Diff<DataStreamOptions> readDiffFrom(StreamInput in)
                                            throws IOException

Throws:

IOException

isEmpty

public boolean isEmpty()

Returns:

true if none of the options are defined

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static DataStreamOptions fromXContent(XContentParser parser)
                                      throws IOException

Throws:

IOException

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

failureStore

@Nullable
public DataStreamFailureStore failureStore()

Returns the value of the failureStore record component.

Returns:

the value of the failureStore record component