com.google.cloud.dataflow.sdk.runners

Class DataflowPipelineJob

java.lang.Object

com.google.cloud.dataflow.sdk.runners.DataflowPipelineJob

All Implemented Interfaces:

PipelineResult

public class DataflowPipelineJob
extends java.lang.Object
implements PipelineResult

A DataflowPipelineJob represents a job submitted to Dataflow using DataflowPipelineRunner.

Constructor Summary

Constructors

Constructor and Description
DataflowPipelineJob(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.Dataflow client) Construct the job.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.services.dataflow.Dataflow	getDataflowClient()
java.lang.String	getJobId()
java.lang.String	getProjectId()
com.google.cloud.dataflow.sdk.util.MonitoringUtil.JobState	waitToFinish(long timeToWait, java.util.concurrent.TimeUnit timeUnit, com.google.cloud.dataflow.sdk.util.MonitoringUtil.JobMessagesHandler messageHandler) Wait for the job to finish and return the final status.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataflowPipelineJob

public DataflowPipelineJob(java.lang.String projectId,
                   java.lang.String jobId,
                   com.google.api.services.dataflow.Dataflow client)

Construct the job.

Parameters:

projectId - the project id

jobId - the job id

client - the workflow client

Method Detail

getJobId

public java.lang.String getJobId()

getProjectId

public java.lang.String getProjectId()

getDataflowClient

public com.google.api.services.dataflow.Dataflow getDataflowClient()

waitToFinish

@Nullable
public com.google.cloud.dataflow.sdk.util.MonitoringUtil.JobState waitToFinish(long timeToWait,
                                                                               java.util.concurrent.TimeUnit timeUnit,
                                                                               com.google.cloud.dataflow.sdk.util.MonitoringUtil.JobMessagesHandler messageHandler)
                                                                        throws java.io.IOException,
                                                                               java.lang.InterruptedException

Wait for the job to finish and return the final status.

Parameters:

timeToWait - The time to wait in units timeUnit for the job to finish.

timeUnit - The unit of time for timeToWait. Provide a negative value for an infinite wait.

messageHandler - If non null this handler will be invoked for each batch of messages received.

Returns:

The final state of the job or null on timeout or if the thread is interrupted.

Throws:

java.io.IOException - If there is a persistent problem getting job information.

java.lang.InterruptedException