Package com.inductiveautomation.eventstream

Record Class EventStreamDiagnostics

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.EventStreamDiagnostics
Record Components:
project - Project Event Stream belongs to
path - Path to Event Stream resource
state - Current state of Event Stream
stageDiagnostics - Map of stage name to StageDiagnostics
public record EventStreamDiagnostics(String project, String path, String state, Map<String,StageDiagnostics> stageDiagnostics) extends Record
Contains diagnostics data for an Event Stream and all it's included stages

  • Constructor Details

    • EventStreamDiagnostics

      public EventStreamDiagnostics(String project, String path, String state, Map<String,StageDiagnostics> stageDiagnostics)
      Creates an instance of a EventStreamDiagnostics record class.
      Parameters:
      project - the value for the project record component
      path - the value for the path record component
      state - the value for the state record component
      stageDiagnostics - the value for the stageDiagnostics record component

  • Method Details

    • mostRecentErrors

      public List<StageError> mostRecentErrors(int count)
      Combines the errors from all stages and returns the most recent
      Parameters:
      count - Max amount of errors to return
      Returns:
      Errors sorted from most recent to oldest

    • getStageDiagnostics

      @Nullable public StageDiagnostics getStageDiagnostics(String stageName)
      Get the StageDiagnostics for a specific stage
      Parameters:
      stageName - Name of the stage
      Returns:
      StageDiagnostics or null if not found

    • 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

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

    • project

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

    • path

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

    • state

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

    • stageDiagnostics

      public Map<String,StageDiagnostics> stageDiagnostics()
      Returns the value of the stageDiagnostics record component.
      Returns:
      the value of the stageDiagnostics record component