org.apache.beam.runners.dataflow.util

Class DataflowTemplateJob

java.lang.Object

org.apache.beam.runners.dataflow.DataflowPipelineJob

org.apache.beam.runners.dataflow.util.DataflowTemplateJob

All Implemented Interfaces:

PipelineResult

public class DataflowTemplateJob
extends DataflowPipelineJob

A DataflowPipelineJob that is returned when --templateRunner is set.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.PipelineResult

PipelineResult.State

Field Summary

Fields inherited from class org.apache.beam.runners.dataflow.DataflowPipelineJob

STATUS_BACKOFF_FACTORY

Constructor Summary

Constructors

Constructor and Description
DataflowTemplateJob()

Method Summary

Modifier and Type	Method and Description
PipelineResult.State	cancel() Cancels the pipeline execution.
java.lang.String	getJobId() Get the id of this job.
java.lang.String	getProjectId() Get the project this job exists in.
DataflowPipelineJob	getReplacedByJob() Returns a new DataflowPipelineJob for the job that replaced this one, if applicable.
PipelineResult.State	getState() Retrieves the current state of the pipeline execution.
MetricResults	metrics() Returns the object to access metrics from the pipeline.

Methods inherited from class org.apache.beam.runners.dataflow.DataflowPipelineJob

getDataflowOptions, getPipelineProto, getRegion, getTransformStepNames, waitUntilFinish, waitUntilFinish, waitUntilFinish

Methods inherited from class java.lang.Object

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

Constructor Detail

DataflowTemplateJob

public DataflowTemplateJob()

Method Detail

getJobId

public java.lang.String getJobId()

Description copied from class: DataflowPipelineJob

Get the id of this job.

Overrides:

getJobId in class DataflowPipelineJob

getProjectId

public java.lang.String getProjectId()

Description copied from class: DataflowPipelineJob

Get the project this job exists in.

Overrides:

getProjectId in class DataflowPipelineJob

getReplacedByJob

public DataflowPipelineJob getReplacedByJob()

Description copied from class: DataflowPipelineJob

Returns a new DataflowPipelineJob for the job that replaced this one, if applicable.

Overrides:

getReplacedByJob in class DataflowPipelineJob

metrics

public MetricResults metrics()

Description copied from interface: PipelineResult

Returns the object to access metrics from the pipeline.

Specified by:

metrics in interface PipelineResult

Overrides:

metrics in class DataflowPipelineJob

cancel

public PipelineResult.State cancel()

Description copied from interface: PipelineResult

Cancels the pipeline execution.

Specified by:

cancel in interface PipelineResult

Overrides:

cancel in class DataflowPipelineJob

getState

public PipelineResult.State getState()

Description copied from interface: PipelineResult

Retrieves the current state of the pipeline execution.

Specified by:

getState in interface PipelineResult

Overrides:

getState in class DataflowPipelineJob

Returns:

the PipelineResult.State representing the state of this pipeline.