Package com.inductiveautomation.eventstream.gateway.stages

Class TransformStage

java.lang.Object

com.inductiveautomation.eventstream.gateway.stages.Stage

com.inductiveautomation.eventstream.gateway.stages.TransformStage

public class TransformStage
extends Stage

Transforms events based return value from user's script function.

Metrics:
{}.transform.received (Meter): Total events received
{}.transform.queueSize (Gauge)
{}.transform.processTimeNs (Histogram)
{}.transform.errors (Counter)

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.eventstream.gateway.stages.Stage

Stage.ProcessResult, Stage.Subscriber

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class com.inductiveautomation.eventstream.gateway.stages.Stage

METRIC_ERROR_COUNT, METRIC_PROCESS_TIME, METRIC_QUEUED_EVENT_COUNT, METRIC_RECEIVED, processTimeNs, receivedMeter, STATE_LAST_EMITTED_EVENT_KEY, STATE_LAST_EVENT_KEY, STATE_TEST_KEY

Constructor Summary

Constructors

Constructor	Description
TransformStage(StageContext context, ScriptFunction transform)

Method Summary

Modifier and Type	Method	Description
Map<String,Number>	getMetrics(com.codahale.metrics.Snapshot processTimeNs)
Stage.ProcessResult	process(StageEvent event)	Provides record from previous stage.

Methods inherited from class com.inductiveautomation.eventstream.gateway.stages.Stage

context, errorCount, forward, getDiagnostics, getErrors, getId, getMetrics, getReferenceLocation, getStatus, getTypeId, includeDiagnostics, log, onError, onSubscribed, onUnsubscribe, processTimeMostRecent, setIncludeDiagnostics, setStatus, subscribe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

TransformStage

public TransformStage(StageContext context,
 ScriptFunction transform)

Method Details

getMetrics

public Map<String,Number> getMetrics(com.codahale.metrics.Snapshot processTimeNs)

Overrides:

getMetrics in class Stage

process

public Stage.ProcessResult process(StageEvent event)

Description copied from class: Stage

Provides record from previous stage. It's important to notify a subscriber of action to take (if any) once a record has been processed. Process is always called from the previous stages thread.

Specified by:

process in class Stage

Returns:

ProcessResult determines if processing can continue