Record Class TimeSpan

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.action.TimeSpan
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public record TimeSpan(long startMillis, long startNanos, long stopMillis, long stopNanos) extends Record implements Writeable, org.elasticsearch.xcontent.ToXContentObject
THis class is used to capture a duration of some process, including start and stop point int time.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     

    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 inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    TimeSpan(long startMillis, long startNanos, long stopMillis, long stopNanos)
    Creates an instance of a TimeSpan record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
     
    long
     
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    static TimeSpan
     
     
    long
    Returns the value of the startMillis record component.
    long
    Returns the value of the startNanos record component.
    long
    Returns the value of the stopMillis record component.
    long
    Returns the value of the stopNanos record component.
    final String
    Returns a string representation of this record class.
    org.elasticsearch.core.TimeValue
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    void
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Constructor Details

    • TimeSpan

      public TimeSpan(long startMillis, long startNanos, long stopMillis, long stopNanos)
      Creates an instance of a TimeSpan record class.
      Parameters:
      startMillis - the value for the startMillis record component
      startNanos - the value for the startNanos record component
      stopMillis - the value for the stopMillis record component
      stopNanos - the value for the stopNanos record component
  • Method Details

    • readFrom

      public static TimeSpan 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 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
    • toTimeValue

      public org.elasticsearch.core.TimeValue toTimeValue()
    • durationInMillis

      public long durationInMillis()
    • durationInNanos

      public long durationInNanos()
    • start

      public static TimeSpan.Builder start()
    • 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 '=='.
      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.
    • startMillis

      public long startMillis()
      Returns the value of the startMillis record component.
      Returns:
      the value of the startMillis record component
    • startNanos

      public long startNanos()
      Returns the value of the startNanos record component.
      Returns:
      the value of the startNanos record component
    • stopMillis

      public long stopMillis()
      Returns the value of the stopMillis record component.
      Returns:
      the value of the stopMillis record component
    • stopNanos

      public long stopNanos()
      Returns the value of the stopNanos record component.
      Returns:
      the value of the stopNanos record component