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 atEventStreamConstants.StagestypeId- 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 typeIdstate- Current state of stage.errors- List of most recent errors up to a maximum ofEventStreamConstants.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 Summary
ConstructorsConstructorDescriptionStageDiagnostics(String name, String typeId, String typeLabel, StageState state, List<StageError> errors, Map<String, Number> metrics) Creates an instance of aStageDiagnosticsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.errors()Returns the value of theerrorsrecord component.longHow many events this stage passed downstream, or0for a stage that does not report a forwarded count.longfinal inthashCode()Returns a hash code value for this object.metrics()Returns the value of themetricsrecord component.name()Returns the value of thenamerecord component.state()Returns the value of thestaterecord component.@NonNull StringtoString()Returns a string representation of this record class.typeId()Returns the value of thetypeIdrecord component.Returns the value of thetypeLabelrecord component.
-
Constructor Details
-
StageDiagnostics
public StageDiagnostics(String name, String typeId, String typeLabel, StageState state, List<StageError> errors, Map<String, Number> metrics) Creates an instance of aStageDiagnosticsrecord class.- Parameters:
name- the value for thenamerecord componenttypeId- the value for thetypeIdrecord componenttypeLabel- the value for thetypeLabelrecord componentstate- the value for thestaterecord componenterrors- the value for theerrorsrecord componentmetrics- the value for themetricsrecord component
-
-
Method Details
-
getReceivedCount
public long getReceivedCount() -
getForwardedCount
public long getForwardedCount()How many events this stage passed downstream, or0for a stage that does not report a forwarded count. -
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
name
-
typeId
-
typeLabel
-
state
-
errors
-
metrics
-