org.apache.beam.runners.direct

Interface TransformResult<InputT>

All Known Implementing Classes:

StepTransformResult

public interface TransformResult<InputT>

The result of evaluating an AppliedPTransform with a TransformEvaluator.

Every transform evaluator has a defined input type, but ParDo has multiple outputs so there is not necesssarily a defined output type.

Method Summary

Modifier and Type	Method and Description
AggregatorContainer.Mutator	getAggregatorChanges() Returns the AggregatorContainer.Mutator used by this PTransform, or null if this transform did not use an AggregatorContainer.Mutator.
MetricUpdates	getLogicalMetricUpdates() Returns the logical metric updates.
Iterable<? extends org.apache.beam.runners.direct.DirectRunner.UncommittedBundle<?>>	getOutputBundles() Returns the (uncommitted) Bundles output by this transform.
Set<org.apache.beam.runners.direct.CommittedResult.OutputType>	getOutputTypes() Returns the types of output produced by this PTransform.
CopyOnAccessInMemoryStateInternals<?>	getState() Returns the State used by the transform.
WatermarkManager.TimerUpdate	getTimerUpdate() Returns a TimerUpdateBuilder that was produced as a result of this evaluation.
AppliedPTransform<?,?,?>	getTransform() Returns the AppliedPTransform that produced this result.
Iterable<? extends WindowedValue<InputT>>	getUnprocessedElements() Returns elements that were provided to the TransformEvaluator as input but were not processed.
org.joda.time.Instant	getWatermarkHold() Returns the Watermark Hold for the transform at the time this result was produced.
TransformResult<InputT>	withLogicalMetricUpdates(MetricUpdates metricUpdates) Returns a new TransformResult based on this one but overwriting any existing logical metric updates with metricUpdates.

Method Detail

getTransform

AppliedPTransform<?,?,?> getTransform()

Returns the AppliedPTransform that produced this result.

This is treated as an opaque identifier so evaluators can delegate to other evaluators that may not have compatible types.

getOutputBundles

Iterable<? extends org.apache.beam.runners.direct.DirectRunner.UncommittedBundle<?>> getOutputBundles()

Returns the (uncommitted) Bundles output by this transform. These will be committed by the evaluation context as part of completing this result.

Note that the bundles need not have a uniform type, for example in the case of multi-output ParDo.

getUnprocessedElements

Iterable<? extends WindowedValue<InputT>> getUnprocessedElements()

Returns elements that were provided to the TransformEvaluator as input but were not processed.

getAggregatorChanges

@Nullable
AggregatorContainer.Mutator getAggregatorChanges()

Returns the AggregatorContainer.Mutator used by this PTransform, or null if this transform did not use an AggregatorContainer.Mutator.

getLogicalMetricUpdates

MetricUpdates getLogicalMetricUpdates()

Returns the logical metric updates.

getWatermarkHold

org.joda.time.Instant getWatermarkHold()

Returns the Watermark Hold for the transform at the time this result was produced.

If the transform does not set any watermark hold, returns BoundedWindow.TIMESTAMP_MAX_VALUE.

getState

@Nullable
CopyOnAccessInMemoryStateInternals<?> getState()

Returns the State used by the transform.

If this evaluation did not access state, this may return null.

getTimerUpdate

WatermarkManager.TimerUpdate getTimerUpdate()

Returns a TimerUpdateBuilder that was produced as a result of this evaluation. If the evaluation was triggered due to the delivery of one or more timers, those timers must be added to the builder before it is complete.

If this evaluation did not add or remove any timers, returns an empty TimerUpdate.

getOutputTypes

Set<org.apache.beam.runners.direct.CommittedResult.OutputType> getOutputTypes()

Returns the types of output produced by this PTransform. This may not include CommittedResult.OutputType.BUNDLE, as empty bundles may be dropped when the transform is committed.

withLogicalMetricUpdates

TransformResult<InputT> withLogicalMetricUpdates(MetricUpdates metricUpdates)

Returns a new TransformResult based on this one but overwriting any existing logical metric updates with metricUpdates.