org.apache.beam.runners.direct

Class DirectRunner

java.lang.Object

org.apache.beam.sdk.PipelineRunner<DirectRunner.DirectPipelineResult>

org.apache.beam.runners.direct.DirectRunner

public class DirectRunner
extends PipelineRunner<DirectRunner.DirectPipelineResult>

A PipelineRunner that executes a Pipeline within the process that constructed the Pipeline.

The DirectRunner is suitable for running a Pipeline on small scale, example, and test data, and should be used for ensuring that processing logic is correct. It also is appropriate for executing unit tests and performs additional work to ensure that behavior contained within a Pipeline does not break assumptions within the Beam model, to improve the ability to execute a Pipeline at scale on a distributed backend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectRunner.DirectPipelineResult The result of running a Pipeline with the DirectRunner.

Method Summary

Modifier and Type	Method and Description
static DirectRunner	fromOptions(PipelineOptions options) Construct a DirectRunner from the provided options.
DirectOptions	getPipelineOptions() Returns the PipelineOptions used to create this DirectRunner.
DirectRunner.DirectPipelineResult	run(Pipeline originalPipeline) Processes the given Pipeline, potentially asynchronously, returning a runner-specific type of result.

Methods inherited from class java.lang.Object

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

Method Detail

fromOptions

public static DirectRunner fromOptions(PipelineOptions options)

Construct a DirectRunner from the provided options.

getPipelineOptions

public DirectOptions getPipelineOptions()

Returns the PipelineOptions used to create this DirectRunner.

run

public DirectRunner.DirectPipelineResult run(Pipeline originalPipeline)

Description copied from class: PipelineRunner

Processes the given Pipeline, potentially asynchronously, returning a runner-specific type of result.

Specified by:

run in class PipelineRunner<DirectRunner.DirectPipelineResult>