Record Class DriverStatus

java.lang.Object
java.lang.Record
org.elasticsearch.compute.operator.DriverStatus
Record Components:
sessionId - The session for this driver.
description - Description of the driver.
clusterName - The name of the cluster this driver is running on.
nodeName - The name of the node this driver is running on.
started - When this Driver was started.
lastUpdated - When this status was generated.
cpuNanos - Nanos this Driver has been running on the cpu. Does not include async or waiting time.
iterations - The number of times the driver has moved a single page up the chain of operators as far as it'll go.
status - The state of the overall driver - queue, starting, running, finished.
completedOperators - Status of each completed Operator in the driver.
activeOperators - Status of each active Operator in the driver.
All Implemented Interfaces:
NamedWriteable, Writeable, Task.Status, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public record DriverStatus(String sessionId, String description, String clusterName, String nodeName, long started, long lastUpdated, long cpuNanos, long iterations, DriverStatus.Status status, List<OperatorStatus> completedOperators, List<OperatorStatus> activeOperators, DriverSleeps sleeps) extends Record implements Task.Status
Task.Status reported from a Driver to be reported by the tasks api.
  • Field Details

  • Constructor Details

    • DriverStatus

      public DriverStatus(String sessionId, String description, String clusterName, String nodeName, long started, long lastUpdated, long cpuNanos, long iterations, DriverStatus.Status status, List<OperatorStatus> completedOperators, List<OperatorStatus> activeOperators, DriverSleeps sleeps)
      Creates an instance of a DriverStatus record class.
      Parameters:
      sessionId - the value for the sessionId record component
      description - the value for the description record component
      clusterName - the value for the clusterName record component
      nodeName - the value for the nodeName record component
      started - the value for the started record component
      lastUpdated - the value for the lastUpdated record component
      cpuNanos - the value for the cpuNanos record component
      iterations - the value for the iterations record component
      status - the value for the status record component
      completedOperators - the value for the completedOperators record component
      activeOperators - the value for the activeOperators record component
      sleeps - the value for the sleeps record component
  • Method Details

    • readFrom

      public static DriverStatus readFrom(StreamInput in) throws IOException
      Throws:
      IOException
    • 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
    • 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
    • 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 driver.
    • valuesLoaded

      public long valuesLoaded()
      The number of values loaded by this operator.
    • 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.
    • sessionId

      public String sessionId()
      Returns the value of the sessionId record component.
      Returns:
      the value of the sessionId record component
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • clusterName

      public String clusterName()
      Returns the value of the clusterName record component.
      Returns:
      the value of the clusterName record component
    • nodeName

      public String nodeName()
      Returns the value of the nodeName record component.
      Returns:
      the value of the nodeName record component
    • started

      public long started()
      Returns the value of the started record component.
      Returns:
      the value of the started record component
    • lastUpdated

      public long lastUpdated()
      Returns the value of the lastUpdated record component.
      Returns:
      the value of the lastUpdated record component
    • cpuNanos

      public long cpuNanos()
      Returns the value of the cpuNanos record component.
      Returns:
      the value of the cpuNanos record component
    • iterations

      public long iterations()
      Returns the value of the iterations record component.
      Returns:
      the value of the iterations record component
    • status

      public DriverStatus.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component
    • completedOperators

      public List<OperatorStatus> completedOperators()
      Returns the value of the completedOperators record component.
      Returns:
      the value of the completedOperators record component
    • activeOperators

      public List<OperatorStatus> activeOperators()
      Returns the value of the activeOperators record component.
      Returns:
      the value of the activeOperators record component
    • sleeps

      public DriverSleeps sleeps()
      Returns the value of the sleeps record component.
      Returns:
      the value of the sleeps record component