Record Class EventStreamConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.config.EventStreamConfig
Record Components:
enabled - True, starts the Event Stream when created. False, will create the Event Stream but won't be started.
source - Source configuration
handlers - Configurations for multiple Handlers, order determines the processing order.
batch - Batch configuration
filter - Filter configuration
transform - Transform configuration
onError - OnError configuration

public record EventStreamConfig(boolean enabled, SourceConfig source, EventStreamEncoder.Config sourceEncoder, List<HandlerConfig> handlers, BatchConfig batch, FilterConfig filter, TransformConfig transform, EventStreamEncoder.Config transformEncoder, OnErrorConfig onError) extends Record
Contains full configuration required to start an Event Stream
  • Constructor Details

  • Method Details

    • createDefault

      public static EventStreamConfig createDefault(String sourceType)
    • createDefaultEncoderConfig

      public static EventStreamEncoder.Config createDefaultEncoderConfig()
    • 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 '=='.
      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.
    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component
    • source

      public SourceConfig source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component
    • sourceEncoder

      public EventStreamEncoder.Config sourceEncoder()
      Returns the value of the sourceEncoder record component.
      Returns:
      the value of the sourceEncoder record component
    • handlers

      public List<HandlerConfig> handlers()
      Returns the value of the handlers record component.
      Returns:
      the value of the handlers record component
    • batch

      public BatchConfig batch()
      Returns the value of the batch record component.
      Returns:
      the value of the batch record component
    • filter

      public FilterConfig filter()
      Returns the value of the filter record component.
      Returns:
      the value of the filter record component
    • transform

      public TransformConfig transform()
      Returns the value of the transform record component.
      Returns:
      the value of the transform record component
    • transformEncoder

      public EventStreamEncoder.Config transformEncoder()
      Returns the value of the transformEncoder record component.
      Returns:
      the value of the transformEncoder record component
    • onError

      public OnErrorConfig onError()
      Returns the value of the onError record component.
      Returns:
      the value of the onError record component