Package com.inductiveautomation.eventstream.stage

Record Class StageDiagnostics

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.stage.StageDiagnostics
Record Components:
name - Name of the stage. All stage names can be found at EventStreamConstants.Stages
typeId - If stage is source or handler, this is the id of EventStreamSource or EventStreamHandler. Otherwise, the typeId will be the same as the name.
typeLabel - Label for the typeId
state - Current state of stage.
errors - List of most recent errors up to a maximum of EventStreamConstants.ERROR_COUNT_MAX.
metrics - Map of metric names to values
public record StageDiagnostics(String name, String typeId, String typeLabel, StageState state, List<StageError> errors, Map<String,Number> metrics) extends Record
Diagnostics for an individual stage

  • Constructor Details

    • StageDiagnostics

      public StageDiagnostics(String name, String typeId, String typeLabel, StageState state, List<StageError> errors, Map<String,Number> metrics)
      Creates an instance of a StageDiagnostics record class.
      Parameters:
      name - the value for the name record component
      typeId - the value for the typeId record component
      typeLabel - the value for the typeLabel record component
      state - the value for the state record component
      errors - the value for the errors record component
      metrics - the value for the metrics record component

  • Method Details

    • toString

      public @NonNull 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.

    • name

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

    • typeId

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

    • typeLabel

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

    • state

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

    • errors

      public List<StageError> errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component

    • metrics

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