org.apache.beam.runners.direct

Class DirectRunner.DirectPipelineResult

java.lang.Object

org.apache.beam.runners.direct.DirectRunner.DirectPipelineResult

All Implemented Interfaces:

PipelineResult

Enclosing class:

DirectRunner

public static class DirectRunner.DirectPipelineResult
extends Object
implements PipelineResult

The result of running a Pipeline with the DirectRunner.

Throws UnsupportedOperationException for all methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.PipelineResult

PipelineResult.State

Method Summary

Modifier and Type	Method and Description
PipelineResult.State	cancel()
<T> AggregatorValues<T>	getAggregatorValues(Aggregator<?,T> aggregator)
PipelineResult.State	getState()
MetricResults	metrics()
PipelineResult.State	waitUntilFinish() Blocks until the Pipeline execution represented by this DirectRunner.DirectPipelineResult is complete, returning the terminal state.
PipelineResult.State	waitUntilFinish(org.joda.time.Duration duration)

Methods inherited from class java.lang.Object

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

Method Detail

getState

public PipelineResult.State getState()

Specified by:

getState in interface PipelineResult

getAggregatorValues

public <T> AggregatorValues<T> getAggregatorValues(Aggregator<?,T> aggregator)
                                            throws AggregatorRetrievalException

Specified by:

getAggregatorValues in interface PipelineResult

Throws:

AggregatorRetrievalException

metrics

public MetricResults metrics()

Specified by:

metrics in interface PipelineResult

waitUntilFinish

public PipelineResult.State waitUntilFinish()

Blocks until the Pipeline execution represented by this DirectRunner.DirectPipelineResult is complete, returning the terminal state.

If the pipeline terminates abnormally by throwing an exception, this will rethrow the exception. Future calls to getState() will return PipelineResult.State.FAILED.

NOTE: if the Pipeline contains an unbounded PCollection, and the PipelineRunner was created with DirectOptions.isShutdownUnboundedProducersWithMaxWatermark() set to false, this method will never return.

See also PipelineExecutor.awaitCompletion().

Specified by:

waitUntilFinish in interface PipelineResult

cancel

public PipelineResult.State cancel()
                            throws IOException

Specified by:

cancel in interface PipelineResult

Throws:

IOException

waitUntilFinish

public PipelineResult.State waitUntilFinish(org.joda.time.Duration duration)

Specified by:

waitUntilFinish in interface PipelineResult