Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.downsample

Record Class DownsampleShardPersistentTaskState

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.downsample.DownsampleShardPersistentTaskState

Record Components:

downsampleShardIndexerStatus - An instance of DownsampleShardIndexerStatus with the downsampleShardIndexerStatus of the downsample task

tsid - The latest successfully processed tsid component of a tuple (tsid, timestamp)

All Implemented Interfaces:

NamedWriteable, Writeable, PersistentTaskState, ToXContent, ToXContentObject

public record DownsampleShardPersistentTaskState(DownsampleShardIndexerStatus downsampleShardIndexerStatus, org.apache.lucene.util.BytesRef tsid)
extends Record
implements PersistentTaskState

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DownsampleShardPersistentTaskState.Builder

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	NAME
static final ObjectParser<DownsampleShardPersistentTaskState.Builder,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DownsampleShardPersistentTaskState(StreamInput in)
DownsampleShardPersistentTaskState(DownsampleShardIndexerStatus downsampleShardIndexerStatus, org.apache.lucene.util.BytesRef tsid)	Creates an instance of a DownsampleShardPersistentTaskState record class.

Method Summary

Modifier and Type	Method	Description
boolean	cancelled()
boolean	done()
DownsampleShardIndexerStatus	downsampleShardIndexerStatus()	Returns the value of the downsampleShardIndexerStatus record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	failed()
static DownsampleShardPersistentTaskState	fromXContent(XContentParser parser)
String	getWriteableName()
final int	hashCode()	Returns a hash code value for this object.
static DownsampleShardPersistentTaskState	readFromStream(StreamInput in)
boolean	started()
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
org.apache.lucene.util.BytesRef	tsid()	Returns the value of the tsid record component.
void	writeTo(StreamOutput out)

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

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER

public static final ObjectParser<DownsampleShardPersistentTaskState.Builder,Void> PARSER

Constructor Details

DownsampleShardPersistentTaskState

public DownsampleShardPersistentTaskState(StreamInput in)
                                   throws IOException

Throws:

IOException

DownsampleShardPersistentTaskState

public DownsampleShardPersistentTaskState(DownsampleShardIndexerStatus downsampleShardIndexerStatus,
 org.apache.lucene.util.BytesRef tsid)

Creates an instance of a DownsampleShardPersistentTaskState record class.

Parameters:

downsampleShardIndexerStatus - the value for the downsampleShardIndexerStatus record component

tsid - the value for the tsid record component

Method Details

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

downsampleShardIndexerStatus

public DownsampleShardIndexerStatus downsampleShardIndexerStatus()

Returns the value of the downsampleShardIndexerStatus record component.

Returns:

the value of the downsampleShardIndexerStatus record component

done

public boolean done()

started

public boolean started()

cancelled

public boolean cancelled()

failed

public boolean failed()

readFromStream

public static DownsampleShardPersistentTaskState readFromStream(StreamInput in)
                                                         throws IOException

Throws:

IOException

fromXContent

public static DownsampleShardPersistentTaskState fromXContent(XContentParser parser)
                                                       throws IOException

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.

tsid

public org.apache.lucene.util.BytesRef tsid()

Returns the value of the tsid record component.

Returns:

the value of the tsid record component