Package org.elasticsearch.xpack.esql.datasources

Class AsyncExternalSourceOperator.Status

java.lang.Object

org.elasticsearch.xpack.esql.datasources.AsyncExternalSourceOperator.Status

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, CapturingExternalSourceStatus, Operator.Status, ToXContent, ToXContentObject

Enclosing class:

AsyncExternalSourceOperator

public static class AsyncExternalSourceOperator.Status
extends Object
implements Operator.Status, CapturingExternalSourceStatus

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 NamedWriteableRegistry.Entry	ENTRY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
long	bytesBuffered()
long	bytesRead()
Map<String,List<Map<String,Object>>>	capturedSourceMetadata()
int	currentSplit()
long	documentsFound()	Projects the operator's existing rowsEmitted counter into the Operator.Status.documentsFound() contract so external-source-emitted rows aggregate into the top-level documents_found of the ES|QL response alongside Lucene-sourced operators, without introducing a new wire field.
boolean	equals(Object o)
Throwable	failure()
FormatReaderStatus	formatReader()
TransportVersion	getMinimalSupportedVersion()
String	getWriteableName()
int	hashCode()
int	pagesEmitted()
int	pagesWaiting()
boolean	partial()
long	processNanos()	Wall time spent inside AsyncExternalSourceOperator.getOutput()'s read loop.
long	readNanos()
long	rowsEmitted()
int	splitsProcessed()
int	splitsTotal()
long	stripesCommitted()	Number of canonical-stripe contributions this scan harvested across all files — the cold-harvest vs miss signal.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, 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

valuesLoaded

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

capturedSourceMetadata

public Map<String,List<Map<String,Object>>> capturedSourceMetadata()

Specified by:

capturedSourceMetadata in interface CapturingExternalSourceStatus

stripesCommitted

public long stripesCommitted()

Number of canonical-stripe contributions this scan harvested across all files — the cold-harvest vs miss signal. A scan that committed stripes (> 0) has populated the coordinator's stats so a future identical query can short-circuit warm; a scan that committed none (== 0, e.g. a safe-miss / harvest-scope-none re-scan) leaves the next query cold.

Derived from capturedSourceMetadata rather than carried as a separate wire field: a stripe-addressed contribution is exactly one carrying ExternalStats.STRIPE_ORDINAL_KEY (with ExternalStats.STRIPE_SIZE_KEY, which marks it cacheable). Counts every such fragment, including sibling fragments of the same stripe, since each is a committed unit of harvest work; this is a "did harvest happen, and how much" signal, not the deduped final stripe count.

partial

public boolean partial()

Specified by:

partial in interface CapturingExternalSourceStatus

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

pagesWaiting

public int pagesWaiting()

pagesEmitted

public int pagesEmitted()

rowsEmitted

public long rowsEmitted()

Specified by:

rowsEmitted in interface Operator.Status

bytesBuffered

public long bytesBuffered()

failure

public Throwable failure()

processNanos

public long processNanos()

Wall time spent inside AsyncExternalSourceOperator.getOutput()'s read loop. Producer-thread time (format-reader open, decode, decompression) lives in format_reader.read_nanos on this same Status, not in this counter.

splitsProcessed

public int splitsProcessed()

splitsTotal

public int splitsTotal()

currentSplit

public int currentSplit()

bytesRead

public long bytesRead()

Specified by:

bytesRead in interface Operator.Status

readNanos

public long readNanos()

Specified by:

readNanos in interface Operator.Status

formatReader

public FormatReaderStatus formatReader()

documentsFound

public long documentsFound()

Projects the operator's existing rowsEmitted counter into the Operator.Status.documentsFound() contract so external-source-emitted rows aggregate into the top-level documents_found of the ES|QL response alongside Lucene-sourced operators, without introducing a new wire field.

Specified by:

documentsFound in interface Operator.Status

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable