Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class DataStreamAutoShardingEvent

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.DataStreamAutoShardingEvent

All Implemented Interfaces:

Diffable<DataStreamAutoShardingEvent>, SimpleDiffable<DataStreamAutoShardingEvent>, Writeable, ToXContent, ToXContentFragment

public record DataStreamAutoShardingEvent(String triggerIndexName, int targetNumberOfShards, long timestamp)
extends Record
implements SimpleDiffable<DataStreamAutoShardingEvent>, ToXContentFragment

Represents the last auto sharding event that occured for a data stream.

Nested Class Summary

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 ParseField	EVENT_TIME
static final ParseField	EVENT_TIME_MILLIS
static final ConstructingObjectParser<DataStreamAutoShardingEvent,Void>	PARSER
static final ParseField	TARGET_NUMBER_OF_SHARDS
static final ParseField	TRIGGER_INDEX_NAME

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
DataStreamAutoShardingEvent(String triggerIndexName, int targetNumberOfShards, long timestamp)	Creates an instance of a DataStreamAutoShardingEvent record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static DataStreamAutoShardingEvent	fromXContent(XContentParser parser)
TimeValue	getTimeSinceLastAutoShardingEvent(LongSupplier now)
final int	hashCode()	Returns a hash code value for this object.
int	targetNumberOfShards()	Returns the value of the targetNumberOfShards record component.
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	triggerIndexName()	Returns the value of the triggerIndexName record component.
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.ToXContentFragment

isFragment

Field Details

TRIGGER_INDEX_NAME

public static final ParseField TRIGGER_INDEX_NAME

TARGET_NUMBER_OF_SHARDS

public static final ParseField TARGET_NUMBER_OF_SHARDS

EVENT_TIME

public static final ParseField EVENT_TIME

EVENT_TIME_MILLIS

public static final ParseField EVENT_TIME_MILLIS

PARSER

public static final ConstructingObjectParser<DataStreamAutoShardingEvent,Void> PARSER

Constructor Details

DataStreamAutoShardingEvent

public DataStreamAutoShardingEvent(String triggerIndexName,
 int targetNumberOfShards,
 long timestamp)

Creates an instance of a DataStreamAutoShardingEvent record class.

Parameters:

triggerIndexName - the value for the triggerIndexName record component

targetNumberOfShards - the value for the targetNumberOfShards record component

timestamp - the value for the timestamp record component

Method Details

fromXContent

public static DataStreamAutoShardingEvent fromXContent(XContentParser parser)
                                                throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

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

getTimeSinceLastAutoShardingEvent

public TimeValue getTimeSinceLastAutoShardingEvent(LongSupplier now)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

triggerIndexName

public String triggerIndexName()

Returns the value of the triggerIndexName record component.

Returns:

the value of the triggerIndexName record component

targetNumberOfShards

public int targetNumberOfShards()

Returns the value of the targetNumberOfShards record component.

Returns:

the value of the targetNumberOfShards record component

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component