Package 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.

Nested Class Summary

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

PipelineResult.State

Method Summary

Modifier and Type	Method	Description
PipelineResult.State	cancel()	Cancels the pipeline execution.
PipelineResult.State	getState()	Retrieves the current state of the pipeline execution.
MetricResults	metrics()	Returns the object to access metrics from the pipeline.
PipelineResult.State	waitUntilFinish()	Waits until the pipeline finishes and returns the final status.
PipelineResult.State	waitUntilFinish(Duration duration)	Waits until the pipeline finishes and returns the final status.

Methods inherited from class java.lang.Object

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

Method Details

getState

public PipelineResult.State getState()

Description copied from interface: PipelineResult

Retrieves the current state of the pipeline execution.

Specified by:

getState in interface PipelineResult

Returns:

the PipelineResult.State representing the state of this pipeline.

metrics

public MetricResults metrics()

Description copied from interface: PipelineResult

Returns the object to access metrics from the pipeline.

Specified by:

metrics in interface PipelineResult

waitUntilFinish

public PipelineResult.State waitUntilFinish()

Waits until the pipeline finishes and returns the final status..

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

Specified by:

waitUntilFinish in interface PipelineResult

Returns:

The final state of the pipeline.

cancel

public PipelineResult.State cancel()

Description copied from interface: PipelineResult

Cancels the pipeline execution.

Specified by:

cancel in interface PipelineResult

waitUntilFinish

public PipelineResult.State waitUntilFinish(Duration duration)

Waits until the pipeline finishes and returns the final status. It times out after the given duration..

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

Specified by:

waitUntilFinish in interface PipelineResult

Parameters:

duration - The time to wait for the pipeline to finish. Provide a value less than 1 ms for an infinite wait.

Returns:

The final state of the pipeline or null on timeout.