Record Class EventStreamRunConfig
java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.EventStreamRunConfig
- Record Components:
dryRun- Flag for handler testMode, if true no side effects will occur.includedStages- Stages to include in the run, or empty to include all stages.preview- Whether the run should capture the shape the most downstream stage specified in theincludedStagesparameter would receive. A previewing run draws its event from the Gateway'sLAST_EVENTSource rather than the accompanying configuration's own, and none of the previewing runs below include a stage past the Transform, so a preview never reaches a Handler.
-
Constructor Summary
ConstructorsConstructorDescriptionEventStreamRunConfig(boolean dryRun, Set<String> includedStages) An ordinary run that previews nothing.EventStreamRunConfig(boolean dryRun, Set<String> includedStages, boolean preview) Creates an instance of aEventStreamRunConfigrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether a previewing run puts the event through the Filter stage on the way to the stage it previews.booleandryRun()Returns the value of thedryRunrecord component.final booleanIndicates whether some other object is "equal to" this one.static EventStreamRunConfigCreates a dry run that previews the Filter stage.final inthashCode()Returns a hash code value for this object.Returns the value of theincludedStagesrecord component.booleanpreview()Returns the value of thepreviewrecord component.booleanWhether a run previews the Filter stage.booleanWhether a run previews the Source stage.booleanWhether a run previews the Transform stage.static EventStreamRunConfigA run that previews the "post-Source shape" a downstream stage would receive: the last event the deployed Event Stream's Source emitted, encoded by the accompanying config'ssourceEncoder.final StringtoString()Returns a string representation of this record class.static EventStreamRunConfigtransformPreview(boolean applyFilter) Creates a dry run that previews the Transform stage, optionally including the Filter stage.
-
Constructor Details
-
EventStreamRunConfig
-
EventStreamRunConfig
Creates an instance of aEventStreamRunConfigrecord class.- Parameters:
dryRun- the value for thedryRunrecord componentincludedStages- the value for theincludedStagesrecord componentpreview- the value for thepreviewrecord component
-
-
Method Details
-
previewsSource
public boolean previewsSource()Whether a run previews the Source stage. -
previewsFilter
public boolean previewsFilter()Whether a run previews the Filter stage. -
previewsTransform
public boolean previewsTransform()Whether a run previews the Transform stage.This is what tells an ordinary run apart from the run that also captures and encodes the Transform's output — the two are otherwise the same run over the same stages, and a run that merely stops at the Transform without asking to preview it reads
falsehere. -
appliesFilter
public boolean appliesFilter()Whether a previewing run puts the event through the Filter stage on the way to the stage it previews. -
sourcePreview
A run that previews the "post-Source shape" a downstream stage would receive: the last event the deployed Event Stream's Source emitted, encoded by the accompanying config'ssourceEncoder. -
filterPreview
Creates a dry run that previews the Filter stage.Requires the config's Filter to be enabled; previewing a disabled Filter reports that rather than running anything.
-
transformPreview
Creates a dry run that previews the Transform stage, optionally including the Filter stage.- Parameters:
applyFilter- whether to put the event through the config's Filter on the way to the Transform
-
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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
dryRun
-
includedStages
Returns the value of theincludedStagesrecord component.- Returns:
- the value of the
includedStagesrecord component
-
preview
-