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 and Description
static DataflowClient	create(DataflowPipelineOptions options)
com.google.api.services.dataflow.model.Job	createJob(com.google.api.services.dataflow.model.Job job) Creates the Dataflow Job.
com.google.api.services.dataflow.model.Job	getJob(String jobId) Gets the Dataflow Job with the given jobId.
com.google.api.services.dataflow.model.JobMetrics	getJobMetrics(String jobId) Gets the JobMetrics with the given jobId.
com.google.api.services.dataflow.model.LeaseWorkItemResponse	leaseWorkItem(String jobId, com.google.api.services.dataflow.model.LeaseWorkItemRequest request) Leases the work item for jobId.
com.google.api.services.dataflow.model.ListJobMessagesResponse	listJobMessages(String jobId, String pageToken) Lists job messages with the given jobId.
com.google.api.services.dataflow.model.ListJobsResponse	listJobs(String pageToken) Lists Dataflow Jobs in the project associated with the DataflowPipelineOptions.
com.google.api.services.dataflow.model.ReportWorkItemStatusResponse	reportWorkItemStatus(String jobId, com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request) Reports the status of the work item for jobId.
com.google.api.services.dataflow.model.Job	updateJob(String jobId, com.google.api.services.dataflow.model.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 com.google.api.services.dataflow.model.Job createJob(@Nonnull
                                                            com.google.api.services.dataflow.model.Job job)
                                                     throws IOException

Creates the Dataflow Job.

Throws:

IOException

listJobs

public com.google.api.services.dataflow.model.ListJobsResponse listJobs(@Nullable
                                                                        String pageToken)
                                                                 throws IOException

Lists Dataflow Jobs in the project associated with the DataflowPipelineOptions.

Throws:

IOException

updateJob

public com.google.api.services.dataflow.model.Job updateJob(@Nonnull
                                                            String jobId,
                                                            @Nonnull
                                                            com.google.api.services.dataflow.model.Job content)
                                                     throws IOException

Updates the Dataflow Job with the given jobId.

Throws:

IOException

getJob

public com.google.api.services.dataflow.model.Job getJob(@Nonnull
                                                         String jobId)
                                                  throws IOException

Gets the Dataflow Job with the given jobId.

Throws:

IOException

getJobMetrics

public com.google.api.services.dataflow.model.JobMetrics getJobMetrics(@Nonnull
                                                                       String jobId)
                                                                throws IOException

Gets the JobMetrics with the given jobId.

Throws:

IOException

listJobMessages

public com.google.api.services.dataflow.model.ListJobMessagesResponse listJobMessages(@Nonnull
                                                                                      String jobId,
                                                                                      @Nullable
                                                                                      String pageToken)
                                                                               throws IOException

Lists job messages with the given jobId.

Throws:

IOException

leaseWorkItem

public com.google.api.services.dataflow.model.LeaseWorkItemResponse leaseWorkItem(@Nonnull
                                                                                  String jobId,
                                                                                  @Nonnull
                                                                                  com.google.api.services.dataflow.model.LeaseWorkItemRequest request)
                                                                           throws IOException

Leases the work item for jobId.

Throws:

IOException

reportWorkItemStatus

public com.google.api.services.dataflow.model.ReportWorkItemStatusResponse reportWorkItemStatus(@Nonnull
                                                                                                String jobId,
                                                                                                @Nonnull
                                                                                                com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request)
                                                                                         throws IOException

Reports the status of the work item for jobId.

Throws:

IOException