Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamLifecycle.Downsampling.Round

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamLifecycle.Downsampling.Round

Record Components:

after - is a TimeValue configuring how old (based on generation age) should a backing index be before downsampling

config - contains the interval that the backing index is going to be downsampled.

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

DataStreamLifecycle.Downsampling

public static record DataStreamLifecycle.Downsampling.Round(TimeValue after, DownsampleConfig config)
extends Record
implements Writeable, ToXContentObject

A round represents the configuration for when and how elasticsearch will downsample a backing index.

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 ParseField	AFTER_FIELD
static final ParseField	FIXED_INTERVAL_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Round(TimeValue after, DownsampleConfig config)	Creates an instance of a Round record class.

Method Summary

Modifier and Type	Method	Description
TimeValue	after()	Returns the value of the after record component.
DownsampleConfig	config()	Returns the value of the config record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static DataStreamLifecycle.Downsampling.Round	fromXContent(XContentParser parser, Void context)
final int	hashCode()	Returns a hash code value for this object.
static DataStreamLifecycle.Downsampling.Round	read(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.xcontent.ToXContentObject

isFragment

Field Details

AFTER_FIELD

public static final ParseField AFTER_FIELD

FIXED_INTERVAL_FIELD

public static final ParseField FIXED_INTERVAL_FIELD

Constructor Details

Round

public Round(TimeValue after,
 DownsampleConfig config)

Creates an instance of a Round record class.

Parameters:

after - the value for the after record component

config - the value for the config record component

Method Details

read

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

fromXContent

public static DataStreamLifecycle.Downsampling.Round fromXContent(XContentParser parser,
 Void context)
                                                           throws IOException

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

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.

after

public TimeValue after()

Returns the value of the after record component.

Returns:

the value of the after record component

config

public DownsampleConfig config()

Returns the value of the config record component.

Returns:

the value of the config record component