Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamOptions.Template

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamOptions.Template

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

DataStreamOptions

public static record DataStreamOptions.Template(ResettableValue<DataStreamFailureStore.Template> failureStore)
extends Record
implements Writeable, ToXContentObject

This class is only used in template configuration. It wraps the fields of DataStreamOptions with ResettableValue to allow a user to signal when they want to reset any previously encountered values during template composition. Furthermore, it provides the DataStreamOptions.Template.Builder that dictates how two templates can be composed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataStreamOptions.Template.Builder	Builds and composes a data stream template.

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.Template	EMPTY
static final ConstructingObjectParser<DataStreamOptions.Template,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Template(ResettableValue<DataStreamFailureStore.Template> failureStore)	Creates an instance of a Template record class.

Method Summary

Modifier and Type	Method	Description
static DataStreamOptions.Template.Builder	builder(DataStreamOptions.Template template)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ResettableValue<DataStreamFailureStore.Template>	failureStore()	Returns the value of the failureStore record component.
static DataStreamOptions.Template	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
static DataStreamOptions.Template	read(StreamInput in)
DataStreamOptions	toDataStreamOptions()
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Converts the template to XContent, depending on the set by ResettableValue.hideResetValues(Params) it may or may not display any explicit nulls when the value is to be reset.
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.xcontent.ToXContentObject

isFragment

Field Details

EMPTY

public static final DataStreamOptions.Template EMPTY

PARSER

public static final ConstructingObjectParser<DataStreamOptions.Template,Void> PARSER

Constructor Details

Template

public Template(ResettableValue<DataStreamFailureStore.Template> failureStore)

Creates an instance of a Template record class.

Parameters:

failureStore - the value for the failureStore record component

Method Details

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

read

public static DataStreamOptions.Template read(StreamInput in)
                                       throws IOException

Throws:

IOException

fromXContent

public static DataStreamOptions.Template fromXContent(XContentParser parser)
                                               throws IOException

Throws:

IOException

toXContent

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

Converts the template to XContent, depending on the set by ResettableValue.hideResetValues(Params) it may or may not display any explicit nulls when the value is to be reset.

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toDataStreamOptions

public DataStreamOptions toDataStreamOptions()

builder

public static DataStreamOptions.Template.Builder builder(DataStreamOptions.Template template)

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

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

public ResettableValue<DataStreamFailureStore.Template> failureStore()

Returns the value of the failureStore record component.

Returns:

the value of the failureStore record component