Enum Class EventStreamSurface

java.lang.Object
java.lang.Enum<EventStreamSurface>
com.inductiveautomation.eventstream.designer.ai.EventStreamSurface
All Implemented Interfaces:
Serializable, Comparable<EventStreamSurface>, Constable

public enum EventStreamSurface extends Enum<EventStreamSurface>

A scripting stage whose Jython body an AI assist can be mounted on, and the key both halves of the grounding are looked up by: the framing string via EventStreamAiGrounding.callerContextFor(EventStreamSurface), and the on-demand sample tool via EventStreamAiGrounding.sampleToolFor(EventStreamSurface).

Each constant stands for fixed, code-verified facts about that stage — the body's signature, what it must return, and which state keys exist — so the same constant passed to both entry points cannot pair one surface's framing with another's sample.

The handler editors are not a surface: they own their overall framing and reach the grounding through EventStreamAiContext instead, since they receive the same late-stage event ERROR does.

  • Enum Constant Details

    • FILTER

      public static final EventStreamSurface FILTER
      onFilter(event, state), returning a boolean that decides whether the event passes through the stream. The one surface upstream of the Filter, so its sample always arrives.
    • TRANSFORM

      public static final EventStreamSurface TRANSFORM
      onTransform(event, state), returning the value the stream carries forward in place of the original event's data, which is then re-encoded by the transform encoder.
    • ERROR

      public static final EventStreamSurface ERROR
      onError(event, state), run on a separate thread when a stage throws, receiving the batch of events that were in flight. Sees the late-stage event shape, the same one the handlers receive.
  • Method Details

    • values

      public static EventStreamSurface[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static EventStreamSurface valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null