org.apache.beam.runners.dataflow

Class DataflowRunner

java.lang.Object

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

org.apache.beam.runners.dataflow.DataflowRunner

public class DataflowRunner
extends PipelineRunner<DataflowPipelineJob>

A PipelineRunner that executes the operations in the pipeline by first translating them to the Dataflow representation using the DataflowPipelineTranslator and then submitting them to a Dataflow service for execution.

Permissions

When reading from a Dataflow source or writing to a Dataflow sink using DataflowRunner, the Google cloudservices account and the Google compute engine service account of the GCP project running the Dataflow Job will need access to the corresponding source/sink.

Please see Google Cloud Dataflow Security and Permissions for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataflowRunner.StreamingPCollectionViewWriterFn<T> A marker DoFn for writing the contents of a PCollection to a streaming PCollectionView backend implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROJECT_ID_REGEXP Project IDs must contain lowercase letters, digits, or dashes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataflowRunner(DataflowPipelineOptions options)

Method Summary

Modifier and Type	Method and Description
protected org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline	applySdkEnvironmentOverrides(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline, DataflowPipelineDebugOptions options)
static DataflowRunner	fromOptions(PipelineOptions options) Construct a runner from the provided options.
DataflowPipelineTranslator	getTranslator() Returns the DataflowPipelineTranslator associated with this object.
static boolean	hasExperiment(DataflowPipelineDebugOptions options, java.lang.String experiment) Returns true if the specified experiment is enabled, handling null experiments.
protected void	replaceV1Transforms(Pipeline pipeline)
protected org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline	resolveArtifacts(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)
DataflowPipelineJob	run(Pipeline pipeline) Processes the given Pipeline, potentially asynchronously, returning a runner-specific type of result.
void	setHooks(DataflowRunnerHooks hooks) Sets callbacks to invoke during execution see DataflowRunnerHooks.
protected java.util.List<DataflowPackage>	stageArtifacts(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)
java.lang.String	toString()

Methods inherited from class org.apache.beam.sdk.PipelineRunner

create, run, run

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_ID_REGEXP

public static final java.lang.String PROJECT_ID_REGEXP

Project IDs must contain lowercase letters, digits, or dashes. IDs must start with a letter and may not end with a dash. This regex isn't exact - this allows for patterns that would be rejected by the service, but this is sufficient for basic validation of project IDs.

See Also:

Constant Field Values

Constructor Detail

DataflowRunner

protected DataflowRunner(DataflowPipelineOptions options)

Method Detail

fromOptions

public static DataflowRunner fromOptions(PipelineOptions options)

Construct a runner from the provided options.

Parameters:

options - Properties that configure the runner.

Returns:

The newly created runner.

applySdkEnvironmentOverrides

protected org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline applySdkEnvironmentOverrides(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline,
                                                                                            DataflowPipelineDebugOptions options)

resolveArtifacts

protected org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline resolveArtifacts(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)

stageArtifacts

protected java.util.List<DataflowPackage> stageArtifacts(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)

run

public DataflowPipelineJob run(Pipeline pipeline)

Description copied from class: PipelineRunner

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

Specified by:

run in class PipelineRunner<DataflowPipelineJob>

hasExperiment

public static boolean hasExperiment(DataflowPipelineDebugOptions options,
                                    java.lang.String experiment)

Returns true if the specified experiment is enabled, handling null experiments.

replaceV1Transforms

protected void replaceV1Transforms(Pipeline pipeline)

getTranslator

public DataflowPipelineTranslator getTranslator()

Returns the DataflowPipelineTranslator associated with this object.

setHooks

@Experimental
public void setHooks(DataflowRunnerHooks hooks)

Sets callbacks to invoke during execution see DataflowRunnerHooks.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object