Package com.inductiveautomation.eventstream

Record Class EventResult

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.EventResult
Record Components:
status - of the event
stage - Stage the event was completed in.
errorMessage - Cause of error if Status is ERROR or ABORTED
All Implemented Interfaces:
Serializable
public record EventResult(EventResult.Status status, String stage, @Nullable String errorMessage, @Nullable Throwable error) extends Record implements Serializable
Result of submitting an event to an Event Stream
See Also:

  • Constructor Details

    • EventResult

      public EventResult(EventResult.Status status, String stage, @Nullable String errorMessage, @Nullable Throwable error)
      Creates an instance of a EventResult record class.
      Parameters:
      status - the value for the status record component
      stage - the value for the stage record component
      errorMessage - the value for the errorMessage record component
      error - the value for the error record component

  • Method Details

    • handled

      public static EventResult handled(String stage)

    • error

      public static EventResult error(String stage, Throwable throwable)

    • dropped

      public static EventResult dropped(String stage)

    • aborted

      public static EventResult aborted(String stage, @Nullable Throwable throwable)

    • fromHandler

      public boolean fromHandler()

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

    • status

      public EventResult.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • stage

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

    • errorMessage

      @Nullable public String errorMessage()
      Returns the value of the errorMessage record component.
      Returns:
      the value of the errorMessage record component

    • error

      @Nullable public Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component