apache_beam.runners.dataflow package

Subpackages

• apache_beam.runners.dataflow.internal package
  • Submodules
  • apache_beam.runners.dataflow.internal.apiclient module
  • apache_beam.runners.dataflow.internal.dependency module
  • apache_beam.runners.dataflow.internal.names module
  • Module contents
• apache_beam.runners.dataflow.native_io package
  • Submodules
  • apache_beam.runners.dataflow.native_io.iobase module
  • Module contents

Submodules

apache_beam.runners.dataflow.dataflow_metrics module

DataflowRunner implementation of MetricResults. It is in charge of responding to queries of current metrics by going to the dataflow service.

class apache_beam.runners.dataflow.dataflow_metrics.DataflowMetrics(dataflow_client=None, job_result=None, job_graph=None)

Bases: apache_beam.metrics.metric.MetricResults

Implementation of MetricResults class for the Dataflow runner.

query(filter=None)

apache_beam.runners.dataflow.dataflow_runner module

A runner implementation that submits a job for remote execution.

The runner will create a JSON description of the job graph and then submit it to the Dataflow Service for remote execution by a worker.

class apache_beam.runners.dataflow.dataflow_runner.DataflowRunner(cache=None)

Bases: apache_beam.runners.runner.PipelineRunner

A runner that creates job graphs and submits them for remote execution.

Every execution of the run() method will submit an independent job for remote execution that consists of the nodes reachable from the passed in node argument or entire graph if node is None. The run() method returns after the service created the job and will not wait for the job to finish if blocking is set to False.

BATCH_ENVIRONMENT_MAJOR_VERSION = '5'

STREAMING_ENVIRONMENT_MAJOR_VERSION = '0'

apply_CombineValues(transform, pcoll)

apply_GroupByKey(transform, pcoll)

static flatten_input_visitor()

static group_by_key_input_visitor()

static poll_for_job_completion(runner, result)

Polls for the specified job to finish running (successfully or not).

run(pipeline)

Remotely executes entire pipeline or parts reachable from node.

run_CombineValues(transform_node)

run_Flatten(transform_node)

run_GroupByKey(transform_node)

run_ParDo(transform_node)

run_Read(transform_node)

run__NativeWrite(transform_node)

apache_beam.runners.dataflow.test_dataflow_runner module

Wrapper of Beam runners that’s built for running and verifying e2e tests.

class apache_beam.runners.dataflow.test_dataflow_runner.TestDataflowRunner(cache=None)

Bases: apache_beam.runners.dataflow.dataflow_runner.DataflowRunner

run(pipeline)

Execute test pipeline and verify test matcher

Module contents

The DataflowRunner executes pipelines on Google Cloud Dataflow.

Anything in this package not imported here is an internal implementation detail with no backwards-compatibility guarantees.