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 the includedStages parameter would receive. A previewing run draws its event from the Gateway's LAST_EVENT Source 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.

public record EventStreamRunConfig(boolean dryRun, Set<String> includedStages, boolean preview) extends Record
Configuration for running a one-off Event Stream, mainly used for test runs in Designer.
  • Constructor Details

    • EventStreamRunConfig

      public EventStreamRunConfig(boolean dryRun, Set<String> includedStages)
      An ordinary run that previews nothing.
    • EventStreamRunConfig

      public EventStreamRunConfig(boolean dryRun, Set<String> includedStages, boolean preview)
      Creates an instance of a EventStreamRunConfig record class.
      Parameters:
      dryRun - the value for the dryRun record component
      includedStages - the value for the includedStages record component
      preview - the value for the preview record 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 false here.

    • appliesFilter

      public boolean appliesFilter()
      Whether a previewing run puts the event through the Filter stage on the way to the stage it previews.
    • sourcePreview

      public static EventStreamRunConfig 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's sourceEncoder.
    • filterPreview

      public static EventStreamRunConfig 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

      public static EventStreamRunConfig transformPreview(boolean applyFilter)
      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

      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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • dryRun

      public boolean dryRun()
      Returns the value of the dryRun record component.
      Returns:
      the value of the dryRun record component
    • includedStages

      public Set<String> includedStages()
      Returns the value of the includedStages record component.
      Returns:
      the value of the includedStages record component
    • preview

      public boolean preview()
      Returns the value of the preview record component.
      Returns:
      the value of the preview record component