google-cloud-dataflow overview (0.22.0)

com.google.dataflow.v1beta3

A client to Dataflow API

The interfaces provided are listed below, along with usage samples.

JobsV1Beta3Client

Service Description: Provides a method to create and modify Google Cloud Dataflow jobs. A Job is a multi-stage computation graph run by the Cloud Dataflow service.

Sample for JobsV1Beta3Client:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(JobsV1Beta3ClientjobsV1Beta3Client=JobsV1Beta3Client.create()){CreateJobRequestrequest=CreateJobRequest.newBuilder().setProjectId("projectId-894832108").setJob(Job.newBuilder().build()).setView(JobView.forNumber(0)).setReplaceJobId("replaceJobId441554788").setLocation("location1901043637").build();Jobresponse=jobsV1Beta3Client.createJob(request);}

MessagesV1Beta3Client

Service Description: The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

Sample for MessagesV1Beta3Client:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MessagesV1Beta3ClientmessagesV1Beta3Client=MessagesV1Beta3Client.create()){ListJobMessagesRequestrequest=ListJobMessagesRequest.newBuilder().setProjectId("projectId-894832108").setJobId("jobId101296568").setMinimumImportance(JobMessageImportance.forNumber(0)).setPageSize(883849137).setPageToken("pageToken873572522").setStartTime(Timestamp.newBuilder().build()).setEndTime(Timestamp.newBuilder().build()).setLocation("location1901043637").build();for(JobMessageelement:messagesV1Beta3Client.listJobMessages(request).iterateAll()){// doThingsWith(element);}}

MetricsV1Beta3Client

Service Description: The Dataflow Metrics API lets you monitor the progress of Dataflow jobs.

Sample for MetricsV1Beta3Client:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MetricsV1Beta3ClientmetricsV1Beta3Client=MetricsV1Beta3Client.create()){GetJobMetricsRequestrequest=GetJobMetricsRequest.newBuilder().setProjectId("projectId-894832108").setJobId("jobId101296568").setStartTime(Timestamp.newBuilder().build()).setLocation("location1901043637").build();JobMetricsresponse=metricsV1Beta3Client.getJobMetrics(request);}

SnapshotsV1Beta3Client

Service Description: Provides methods to manage snapshots of Google Cloud Dataflow jobs.

Sample for SnapshotsV1Beta3Client:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(SnapshotsV1Beta3ClientsnapshotsV1Beta3Client=SnapshotsV1Beta3Client.create()){GetSnapshotRequestrequest=GetSnapshotRequest.newBuilder().setProjectId("projectId-894832108").setSnapshotId("snapshotId-1113817601").setLocation("location1901043637").build();Snapshotresponse=snapshotsV1Beta3Client.getSnapshot(request);}

TemplatesServiceClient

Service Description: Provides a method to create Cloud Dataflow jobs from templates.

Sample for TemplatesServiceClient:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(TemplatesServiceClienttemplatesServiceClient=TemplatesServiceClient.create()){CreateJobFromTemplateRequestrequest=CreateJobFromTemplateRequest.newBuilder().setProjectId("projectId-894832108").setJobName("jobName-1438096408").putAllParameters(newHashMap<String,String>()).setEnvironment(RuntimeEnvironment.newBuilder().build()).setLocation("location1901043637").build();Jobresponse=templatesServiceClient.createJobFromTemplate(request);}

FlexTemplatesServiceClient

Service Description: Provides a service for Flex templates. This feature is not ready yet.

Sample for FlexTemplatesServiceClient:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(FlexTemplatesServiceClientflexTemplatesServiceClient=FlexTemplatesServiceClient.create()){LaunchFlexTemplateRequestrequest=LaunchFlexTemplateRequest.newBuilder().setProjectId("projectId-894832108").setLaunchParameter(LaunchFlexTemplateParameter.newBuilder().build()).setLocation("location1901043637").setValidateOnly(true).build();LaunchFlexTemplateResponseresponse=flexTemplatesServiceClient.launchFlexTemplate(request);}

com.google.dataflow.v1beta3.stub

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-01 UTC.