Module org.elasticsearch.compute
Package org.elasticsearch.compute.operator

Record Class OperatorStatus

java.lang.Object
java.lang.Record
org.elasticsearch.compute.operator.OperatorStatus
Record Components:
operator - String representation of the Operator.
status - Status as reported by the Operator.
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
public record OperatorStatus(String operator, Operator.Status status) extends Record implements Writeable, ToXContentObject
Status of an Operator.

  • Constructor Details

    • OperatorStatus

      public OperatorStatus(String operator, @Nullable Operator.Status status)
      Creates an instance of a OperatorStatus record class.
      Parameters:
      operator - the value for the operator record component
      status - the value for the status record component

  • Method Details

    • readFrom

      public static OperatorStatus readFrom(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      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

    • 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

    • documentsFound

      public long documentsFound()
      The number of documents found by this operator. Most operators don't find documents and will return 0 here.

    • valuesLoaded

      public long valuesLoaded()
      The number of values loaded by this operator. Most operators don't load values and will return 0 here.

    • rowsEmitted

      public long rowsEmitted()
      Rows this operator emitted to its downstream consumer. Source operators populate; pass-through operators return 0.

    • bytesRead

      public long bytesRead()
      Pre-decompression bytes pulled from the storage layer. Populated by external-source operators; others return 0.

    • readNanos

      public long readNanos()
      Wall time the format reader spent reading on the producer thread, in nanoseconds. Populated by external-source operators; others return 0.

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

    • operator

      public String operator()
      Returns the value of the operator record component.
      Returns:
      the value of the operator record component

    • status

      @Nullable public Operator.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component