Record Class BatchConfig
java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.config.BatchConfig
- Record Components:
debounceMs- Amount of time to wait after event arrives to forward events. Incoming events will reset the debounce time.maxWaitMs- Max time to wait before forwarding eventsmaxQueueSize- Max amount of items to batch before dropping based on overflow. -1 for no limit.overflow- Determines behavior when maxQueueSize has been hit
public record BatchConfig(long debounceMs, long maxWaitMs, int maxQueueSize, BatchConfig.Overflow overflow)
extends Record
Configuration for batching
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic BatchConfigDefault batching settings.static BatchConfigPrevent batching, items will be forwarded one at a time on a separate thread from previous stage. -
Constructor Summary
ConstructorsConstructorDescriptionBatchConfig(long debounceMs, long maxWaitMs, int maxQueueSize, BatchConfig.Overflow overflow) Creates an instance of aBatchConfigrecord class. -
Method Summary
Modifier and TypeMethodDescriptionlongReturns the value of thedebounceMsrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.intReturns the value of themaxQueueSizerecord component.longReturns the value of themaxWaitMsrecord component.overflow()Returns the value of theoverflowrecord component.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
DEFAULT
Default batching settings. Should be used on initial EventStreamConfig creation -
NO_BATCHING
Prevent batching, items will be forwarded one at a time on a separate thread from previous stage.
-
-
Constructor Details
-
BatchConfig
public BatchConfig(long debounceMs, long maxWaitMs, int maxQueueSize, BatchConfig.Overflow overflow) Creates an instance of aBatchConfigrecord class.- Parameters:
debounceMs- the value for thedebounceMsrecord componentmaxWaitMs- the value for themaxWaitMsrecord componentmaxQueueSize- the value for themaxQueueSizerecord componentoverflow- the value for theoverflowrecord component
-
-
Method Details
-
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. -
debounceMs
public long debounceMs()Returns the value of thedebounceMsrecord component.- Returns:
- the value of the
debounceMsrecord component
-
maxWaitMs
-
maxQueueSize
public int maxQueueSize()Returns the value of themaxQueueSizerecord component.- Returns:
- the value of the
maxQueueSizerecord component
-
overflow
-