Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamLifecycle.Downsampling

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamLifecycle.Downsampling

Record Components:

rounds - is a list of downsampling configuration which instructs when a backing index should be downsampled (`after`) and at which interval (`fixed_interval`). Null represents an explicit no downsampling during template composition.

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

Enclosing class:

DataStreamLifecycle

public static record DataStreamLifecycle.Downsampling(List<DataStreamLifecycle.Downsampling.Round> rounds)
extends Record
implements Writeable, ToXContentFragment

Downsampling holds the configuration about when should elasticsearch downsample a backing index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataStreamLifecycle.Downsampling.Round	A round represents the configuration for when and how elasticsearch will downsample a backing index.

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 long	FIVE_MINUTES_MILLIS
static final DataStreamLifecycle.Downsampling	NULL

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Downsampling(List<DataStreamLifecycle.Downsampling.Round> rounds)	Creates an instance of a Downsampling record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static DataStreamLifecycle.Downsampling	read(StreamInput in)
List<DataStreamLifecycle.Downsampling.Round>	rounds()	Returns the value of the rounds record component.
final 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.xcontent.ToXContentFragment

isFragment

Field Details

FIVE_MINUTES_MILLIS

public static final long FIVE_MINUTES_MILLIS

NULL

public static final DataStreamLifecycle.Downsampling NULL

Constructor Details

Downsampling

public Downsampling(@Nullable
 List<DataStreamLifecycle.Downsampling.Round> rounds)

Creates an instance of a Downsampling record class.

Parameters:

rounds - the value for the rounds record component

Method Details

read

public static DataStreamLifecycle.Downsampling read(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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public final 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.

rounds

@Nullable
public List<DataStreamLifecycle.Downsampling.Round> rounds()

Returns the value of the rounds record component.

Returns:

the value of the rounds record component