org.apache.beam.sdk

Class PipelineRunner<ResultT extends PipelineResult>

java.lang.Object

org.apache.beam.sdk.PipelineRunner<ResultT>

Type Parameters:

ResultT - the type of the result of run(org.apache.beam.sdk.Pipeline), often a handle to a running job.

Direct Known Subclasses:

CrashingRunner, DataflowRunner, DirectRunner, FlinkRunner, JetRunner, PortableRunner, SparkRunner, SparkRunnerDebugger, SparkStructuredStreamingRunner, TestDataflowRunner, TestFlinkRunner, TestPortableRunner, TestSparkRunner, TestUniversalRunner, Twister2Runner, Twister2TestRunner

public abstract class PipelineRunner<ResultT extends PipelineResult>
extends java.lang.Object

A PipelineRunner runs a Pipeline.

Constructor Summary

Constructors

Constructor and Description
PipelineRunner()

Method Summary

Modifier and Type	Method and Description
static PipelineRunner<? extends PipelineResult>	create() Creates a runner from the default app PipelineOptions.
static PipelineRunner<? extends PipelineResult>	fromOptions(PipelineOptions options) Constructs a runner from the provided PipelineOptions.
abstract ResultT	run(Pipeline pipeline) Processes the given Pipeline, potentially asynchronously, returning a runner-specific type of result.
ResultT	run(PTransform<PBegin,?> pTransform) Overloaded PTransform runner that runs with the default app PipelineOptions.
ResultT	run(PTransform<PBegin,?> pTransform, PipelineOptions options) Creates a Pipeline out of a single PTransform step, and executes it.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineRunner

public PipelineRunner()

Method Detail

fromOptions

public static PipelineRunner<? extends PipelineResult> fromOptions(PipelineOptions options)

Constructs a runner from the provided PipelineOptions.

Returns:

The newly created runner.

create

public static PipelineRunner<? extends PipelineResult> create()

Creates a runner from the default app PipelineOptions.

Returns:

The newly created runner.

run

public abstract ResultT run(Pipeline pipeline)

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

run

public ResultT run(PTransform<PBegin,?> pTransform,
                   PipelineOptions options)

Creates a Pipeline out of a single PTransform step, and executes it.

run

public ResultT run(PTransform<PBegin,?> pTransform)

Overloaded PTransform runner that runs with the default app PipelineOptions.