Package org.apache.beam.runners.dataflow

Class DataflowClient

java.lang.Object

org.apache.beam.runners.dataflow.DataflowClient

public class DataflowClient
extends Object

Wrapper around the generated Dataflow client to provide common functionality.

Method Summary

Modifier and Type	Method	Description
static DataflowClient	create(DataflowPipelineOptions options)
Job	createJob(Job job)	Creates the Dataflow Job.
Job	getJob(String jobId)	Gets the Dataflow Job with the given jobId.
JobMetrics	getJobMetrics(String jobId)	Gets the JobMetrics with the given jobId.
LeaseWorkItemResponse	leaseWorkItem(String jobId, LeaseWorkItemRequest request)	Leases the work item for jobId.
ListJobMessagesResponse	listJobMessages(String jobId, @Nullable String pageToken)	Lists job messages with the given jobId.
ListJobsResponse	listJobs(@Nullable String pageToken)	Lists Dataflow Jobs in the project associated with the DataflowPipelineOptions.
ReportWorkItemStatusResponse	reportWorkItemStatus(String jobId, ReportWorkItemStatusRequest request)	Reports the status of the work item for jobId.
Job	updateJob(String jobId, Job content)	Updates the Dataflow Job with the given jobId.

Methods inherited from class java.lang.Object

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

Method Details

create

public static DataflowClient create(DataflowPipelineOptions options)

createJob

public Job createJob(@Nonnull
 Job job)
              throws IOException

Creates the Dataflow Job.

Throws:

IOException

listJobs

public ListJobsResponse listJobs(@Nullable String pageToken)
                          throws IOException

Lists Dataflow Jobs in the project associated with the DataflowPipelineOptions.

Throws:

IOException

updateJob

public Job updateJob(@Nonnull
 String jobId,
 @Nonnull
 Job content)
              throws IOException

Updates the Dataflow Job with the given jobId.

Throws:

IOException

getJob

public Job getJob(@Nonnull
 String jobId)
           throws IOException

Gets the Dataflow Job with the given jobId.

Throws:

IOException

getJobMetrics

public JobMetrics getJobMetrics(@Nonnull
 String jobId)
                         throws IOException

Gets the JobMetrics with the given jobId.

Throws:

IOException

listJobMessages

public ListJobMessagesResponse listJobMessages(@Nonnull
 String jobId,
 @Nullable String pageToken)
                                        throws IOException

Lists job messages with the given jobId.

Throws:

IOException

leaseWorkItem

public LeaseWorkItemResponse leaseWorkItem(@Nonnull
 String jobId,
 @Nonnull
 LeaseWorkItemRequest request)
                                    throws IOException

Leases the work item for jobId.

Throws:

IOException

reportWorkItemStatus

public ReportWorkItemStatusResponse reportWorkItemStatus(@Nonnull
 String jobId,
 @Nonnull
 ReportWorkItemStatusRequest request)
                                                  throws IOException

Reports the status of the work item for jobId.

Throws:

IOException