Enum Class CollectionMode
java.lang.Object
java.lang.Enum<CollectionMode>
com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionMode
- All Implemented Interfaces:
Serializable, Comparable<CollectionMode>, Constable
How a
DataCollector schedules processing of the data it receives.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionProcessing starts only whenDataCollector.executeDataCollection(CollectionContext)is called.Data is processed and stored in near real time, independent ofDataCollector.executeDataCollection(CollectionContext). -
Method Summary
Modifier and TypeMethodDescriptionstatic CollectionModeReturns the enum constant of this class with the specified name.static CollectionMode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
STREAMING
Data is processed and stored in near real time, independent ofDataCollector.executeDataCollection(CollectionContext). The collector may debounce or cap the wait to group data efficiently; a collection in this mode may trigger immediate processing of pending data. -
MANUAL
Processing starts only whenDataCollector.executeDataCollection(CollectionContext)is called. Incoming data queues between calls, and each call processes and stores everything accumulated since the previous one.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-