Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamFailureStore

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamFailureStore

All Implemented Interfaces:

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

public record DataStreamFailureStore(Boolean enabled)
extends Record
implements SimpleDiffable<DataStreamFailureStore>, ToXContentObject

Holds the data stream failure store metadata that enable or disable the failure store of a data stream. Currently, it supports the following configurations only explicitly enabling or disabling the failure store

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataStreamFailureStore.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 String	ENABLED
static final ParseField	ENABLED_FIELD
static final String	FAILURE_STORE
static final ConstructingObjectParser<DataStreamFailureStore,Void>	PARSER

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataStreamFailureStore(Boolean enabled)	Creates an instance of a DataStreamFailureStore record class.
DataStreamFailureStore(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Boolean	enabled()	Returns the value of the enabled record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static DataStreamFailureStore	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
static Diff<DataStreamFailureStore>	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

public static final String FAILURE_STORE

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

ENABLED_FIELD

public static final ParseField ENABLED_FIELD

PARSER

public static final ConstructingObjectParser<DataStreamFailureStore,Void> PARSER

Constructor Details

DataStreamFailureStore

public DataStreamFailureStore(Boolean enabled)

Creates an instance of a DataStreamFailureStore record class.

Parameters:

enabled - the value for the enabled record component

DataStreamFailureStore

public DataStreamFailureStore(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

readDiffFrom

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

Throws:

IOException

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 DataStreamFailureStore 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.

enabled

public Boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component