PipelineRunner (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. After August 12, 2020, you can use unsupported SDKs temporarily while you upgrade your pipelines. For more information, see Using an unsupported SDK.

For information on migrating from the 1.x SDK, see Migrating from Dataflow SDK 1.x for Java.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk.runners

Class PipelineRunner<ResultT extends PipelineResult>

• java.lang.Object
• • com.google.cloud.dataflow.sdk.runners.PipelineRunner<ResultT>

• Type Parameters:

  ResultT - the type of the result of run(com.google.cloud.dataflow.sdk.Pipeline).

  Direct Known Subclasses:

  BlockingDataflowPipelineRunner, DataflowPipelineRunner, DirectPipelineRunner, InProcessPipelineRunner, TemplatingDataflowPipelineRunner, TestDataflowPipelineRunner

  ---

  
  

  public abstract class PipelineRunner<ResultT extends PipelineResult>
  extends Object

  A PipelineRunner can execute, translate, or otherwise process a Pipeline.

• • Constructor Summary

    Constructors 

    Constructor and Description
    PipelineRunner()

  • Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 

    Modifier and Type	Method and Description
    <OutputT extends POutput,InputT extends PInput> OutputT	apply(PTransform<InputT,OutputT> transform, InputT input) Applies a transform to the given input, returning the output.
    static PipelineRunner<? extends PipelineResult>	fromOptions(PipelineOptions options) Constructs a runner from the provided options.
    abstract ResultT	run(Pipeline pipeline) Processes the given Pipeline, returning the results.

    • 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 options.

      Returns:

      The newly created runner.

    • run

      public abstract ResultT run(Pipeline pipeline)

      Processes the given Pipeline, returning the results.

    • apply

      public <OutputT extends POutput,InputT extends PInput> OutputT apply(PTransform<InputT,OutputT> transform,
                                                                           InputT input)

      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.