Module org.elasticsearch.compute

Package org.elasticsearch.compute.operator

Record Class MetricsInfoOperator.Status

java.lang.Object

java.lang.Record

org.elasticsearch.compute.operator.MetricsInfoOperator.Status

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Operator.Status, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

Enclosing class:

MetricsInfoOperator

public static record MetricsInfoOperator.Status(MetricsInfoOperator.Mode mode, int pagesReceived, long rowsReceived, long rowsEmitted, int metricsAccumulated)
extends Record
implements Operator.Status

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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 NamedWriteableRegistry.Entry	ENTRY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Status(MetricsInfoOperator.Mode mode, int pagesReceived, long rowsReceived, long rowsEmitted, int metricsAccumulated)	Creates an instance of a Status record class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
TransportVersion	getMinimalSupportedVersion()
String	getWriteableName()
int	hashCode()	Returns a hash code value for this object.
int	metricsAccumulated()	Returns the value of the metricsAccumulated record component.
MetricsInfoOperator.Mode	mode()	Returns the value of the mode record component.
int	pagesReceived()	Returns the value of the pagesReceived record component.
long	rowsEmitted()	Returns the value of the rowsEmitted record component.
long	rowsReceived()	Returns the value of the rowsReceived record component.
boolean	supportsVersion(TransportVersion version)
String	toString()	Returns a string representation of this record class.
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
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.compute.operator.Operator.Status

documentsFound, valuesLoaded

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

Status

public Status(MetricsInfoOperator.Mode mode,
 int pagesReceived,
 long rowsReceived,
 long rowsEmitted,
 int metricsAccumulated)

Creates an instance of a Status record class.

Parameters:

mode - the value for the mode record component

pagesReceived - the value for the pagesReceived record component

rowsReceived - the value for the rowsReceived record component

rowsEmitted - the value for the rowsEmitted record component

metricsAccumulated - the value for the metricsAccumulated record component

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

equals

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

hashCode

public 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

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

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

supportsVersion

public boolean supportsVersion(TransportVersion version)

Specified by:

supportsVersion in interface VersionedNamedWriteable

mode

public MetricsInfoOperator.Mode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

pagesReceived

public int pagesReceived()

Returns the value of the pagesReceived record component.

Returns:

the value of the pagesReceived record component

rowsReceived

public long rowsReceived()

Returns the value of the rowsReceived record component.

Returns:

the value of the rowsReceived record component

rowsEmitted

public long rowsEmitted()

Returns the value of the rowsEmitted record component.

Returns:

the value of the rowsEmitted record component

metricsAccumulated

public int metricsAccumulated()

Returns the value of the metricsAccumulated record component.

Returns:

the value of the metricsAccumulated record component