org.apache.beam.runners.dataflow

Class DataflowClient

java.lang.Object

org.apache.beam.runners.dataflow.DataflowClient

public class DataflowClient
extends java.lang.Object

Wrapper around the generated Dataflow client to provide common functionality.

Method Summary

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

create

public static DataflowClient create(DataflowPipelineOptions options)

createJob

public Job createJob(@Nonnull
                     Job job)
              throws java.io.IOException

Creates the Dataflow Job.

Throws:

java.io.IOException

listJobs

public ListJobsResponse listJobs(@Nullable java.lang.String pageToken)
                          throws java.io.IOException

Lists Dataflow Jobs in the project associated with the DataflowPipelineOptions.

Throws:

java.io.IOException

updateJob

public Job updateJob(@Nonnull
                     java.lang.String jobId,
                     @Nonnull
                     Job content)
              throws java.io.IOException

Updates the Dataflow Job with the given jobId.

Throws:

java.io.IOException

getJob

public Job getJob(@Nonnull
                  java.lang.String jobId)
           throws java.io.IOException

Gets the Dataflow Job with the given jobId.

Throws:

java.io.IOException

getJobMetrics

public JobMetrics getJobMetrics(@Nonnull
                                java.lang.String jobId)
                         throws java.io.IOException

Gets the JobMetrics with the given jobId.

Throws:

java.io.IOException

listJobMessages

public ListJobMessagesResponse listJobMessages(@Nonnull
                                               java.lang.String jobId,
                                               @Nullable java.lang.String pageToken)
                                        throws java.io.IOException

Lists job messages with the given jobId.

Throws:

java.io.IOException

leaseWorkItem

public LeaseWorkItemResponse leaseWorkItem(@Nonnull
                                           java.lang.String jobId,
                                           @Nonnull
                                           LeaseWorkItemRequest request)
                                    throws java.io.IOException

Leases the work item for jobId.

Throws:

java.io.IOException

reportWorkItemStatus

public ReportWorkItemStatusResponse reportWorkItemStatus(@Nonnull
                                                         java.lang.String jobId,
                                                         @Nonnull
                                                         ReportWorkItemStatusRequest request)
                                                  throws java.io.IOException

Reports the status of the work item for jobId.

Throws:

java.io.IOException