Package com.valhalla.sdk

Record Class SafeInterruptTelemetry.Snapshot

java.lang.Object
java.lang.Record
com.valhalla.sdk.SafeInterruptTelemetry.Snapshot
Enclosing class:
SafeInterruptTelemetry
public static record SafeInterruptTelemetry.Snapshot(boolean requested, boolean safeToInterrupt, String reason) extends Record
One normalized safe-interrupt observation emitted by the runtime.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Snapshot(boolean requested, boolean safeToInterrupt, String reason)
    Creates an instance of a Snapshot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    ready()
     
    String
    reason()
    Returns the value of the reason record component.
    boolean
    requested()
    Returns the value of the requested record component.
    boolean
    safeToInterrupt()
    Returns the value of the safeToInterrupt record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    workInProgress()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Snapshot

      public Snapshot(boolean requested, boolean safeToInterrupt, String reason)
      Creates an instance of a Snapshot record class.
      Parameters:
      requested - the value for the requested record component
      safeToInterrupt - the value for the safeToInterrupt record component
      reason - the value for the reason record component

  • Method Details

    • ready

      public boolean ready()
      Returns:
      true only after both a platform request and a safe gate sample

    • workInProgress

      public boolean workInProgress()
      Returns:
      whether the script currently owns indivisible work

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

    • requested

      public boolean requested()
      Returns the value of the requested record component.
      Returns:
      the value of the requested record component

    • safeToInterrupt

      public boolean safeToInterrupt()
      Returns the value of the safeToInterrupt record component.
      Returns:
      the value of the safeToInterrupt record component

    • reason

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