com.google.cloud.dataflow.sdk.runners

Class DataflowPipelineRunner

java.lang.Object

com.google.cloud.dataflow.sdk.runners.PipelineRunner<DataflowPipelineJob>

com.google.cloud.dataflow.sdk.runners.DataflowPipelineRunner

public class DataflowPipelineRunner
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.

Method Summary

Methods

Modifier and Type	Method and Description
<Output extends POutput,Input extends PInput> Output	apply(PTransform<Input,Output> transform, Input input) Applies a transform to the given input, returning the output.
protected static java.util.List<java.lang.String>	detectClassPathResourcesToStage(java.lang.ClassLoader classLoader) Attempts to detect all the resources the class loader has access to.
static DataflowPipelineRunner	fromOptions(PipelineOptions options) Construct a runner from the provided options.
DataflowPipelineTranslator	getTranslator() Returns the DataflowPipelineTranslator associated with this object.
DataflowPipelineJob	run(Pipeline pipeline) Processes the given Pipeline, returning the results.
void	setHooks(DataflowPipelineRunnerHooks hooks) Sets callbacks to invoke during execution see DataflowPipelineRunnerHooks.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

fromOptions

public static DataflowPipelineRunner fromOptions(PipelineOptions options)

Construct a runner from the provided options.

Parameters:

options - Properties which configure the runner.

Returns:

The newly created runner.

apply

public <Output extends POutput,Input extends PInput> Output apply(PTransform<Input,Output> transform,
                                                         Input input)

Description copied from class: PipelineRunner

Applies a transform to the given input, returning the output.

The default implementation calls PTransform.apply(input), but can be overridden to customize behavior for a particular runner.

Overrides:

apply in class PipelineRunner<DataflowPipelineJob>

run

public DataflowPipelineJob run(Pipeline pipeline)

Description copied from class: PipelineRunner

Processes the given Pipeline, returning the results.

Specified by:

run in class PipelineRunner<DataflowPipelineJob>

getTranslator

public DataflowPipelineTranslator getTranslator()

Returns the DataflowPipelineTranslator associated with this object.

setHooks

public void setHooks(DataflowPipelineRunnerHooks hooks)

Sets callbacks to invoke during execution see DataflowPipelineRunnerHooks. Important: setHooks is experimental. Please consult with the Dataflow team before using it. You should expect this class to change significantly in future versions of the SDK or be removed entirely.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

detectClassPathResourcesToStage

protected static java.util.List<java.lang.String> detectClassPathResourcesToStage(java.lang.ClassLoader classLoader)

Attempts to detect all the resources the class loader has access to. This does not recurse to class loader parents stopping it from pulling in resources from the system class loader.

Parameters:

classLoader - The URLClassLoader to use to detect resources to stage.

Returns:

A list of absolute paths to the resources the class loader uses.

Throws:

java.lang.IllegalArgumentException - If either the class loader is not a URLClassLoader or one of the resources the class loader exposes is not a file resource.