Class JobsV1Beta3Client (0.45.0)

Version 0.45.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJob(Job.newBuilder().build())
           .setView(JobView.forNumber(0))
           .setReplaceJobId("replaceJobId441554788")
           .setLocation("location1901043637")
           .build();
   Job response = jobsV1Beta3Client.createJob(request);
 }
 

Note: close() needs to be called on the JobsV1Beta3Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
CreateJob	Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createJob(CreateJobRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createJobCallable()
GetJob	Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getJob(GetJobRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getJobCallable()
UpdateJob	Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using projects.locations.jobs.update with a regional endpoint. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateJob(UpdateJobRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateJobCallable()
ListJobs	List the jobs of a project. To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, as you can only get the list of jobs that are running in us-central1.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listJobs(ListJobsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listJobsPagedCallable() listJobsCallable()
AggregatedListJobs	List the jobs of a project across all regions.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedListJobs(ListJobsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. aggregatedListJobsPagedCallable() aggregatedListJobsCallable()
CheckActiveJobs	Check for existence of active jobs in the given project across all regions.	Request object method variants only take one parameter, a request object, which must be constructed before the call. checkActiveJobs(CheckActiveJobsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. checkActiveJobsCallable()
SnapshotJob	Snapshot the state of a streaming job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. snapshotJob(SnapshotJobRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. snapshotJobCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of JobsV1Beta3Settings to create(). For example:

To customize credentials:

 // 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_library
 JobsV1Beta3Settings jobsV1Beta3Settings =
     JobsV1Beta3Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create(jobsV1Beta3Settings);
 

To customize the endpoint:

 // 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_library
 JobsV1Beta3Settings jobsV1Beta3Settings =
     JobsV1Beta3Settings.newBuilder().setEndpoint(myEndpoint).build();
 JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create(jobsV1Beta3Settings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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_library
 JobsV1Beta3Settings jobsV1Beta3Settings = JobsV1Beta3Settings.newHttpJsonBuilder().build();
 JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create(jobsV1Beta3Settings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > JobsV1Beta3Client

Static Methods

create()

public static final JobsV1Beta3Client create()

Constructs an instance of JobsV1Beta3Client with default settings.

Returns
Type	Description
JobsV1Beta3Client

Exceptions
Type	Description
IOException

create(JobsV1Beta3Settings settings)

public static final JobsV1Beta3Client create(JobsV1Beta3Settings settings)

Constructs an instance of JobsV1Beta3Client, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	JobsV1Beta3Settings

Returns
Type	Description
JobsV1Beta3Client

Exceptions
Type	Description
IOException

create(JobsV1Beta3Stub stub)

public static final JobsV1Beta3Client create(JobsV1Beta3Stub stub)

Constructs an instance of JobsV1Beta3Client, using the given stub for making calls. This is for advanced usage - prefer using create(JobsV1Beta3Settings).

Parameter
Name	Description
stub	JobsV1Beta3Stub

Returns
Type	Description
JobsV1Beta3Client

Constructors

JobsV1Beta3Client(JobsV1Beta3Settings settings)

protected JobsV1Beta3Client(JobsV1Beta3Settings settings)

Constructs an instance of JobsV1Beta3Client, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
settings	JobsV1Beta3Settings

JobsV1Beta3Client(JobsV1Beta3Stub stub)

protected JobsV1Beta3Client(JobsV1Beta3Stub stub)

Parameter
Name	Description
stub	JobsV1Beta3Stub

Methods

aggregatedListJobs(ListJobsRequest request)

public final JobsV1Beta3Client.AggregatedListJobsPagedResponse aggregatedListJobs(ListJobsRequest request)

List the jobs of a project across all regions.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   for (Job element : jobsV1Beta3Client.aggregatedListJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListJobsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
JobsV1Beta3Client.AggregatedListJobsPagedResponse

aggregatedListJobsCallable()

public final UnaryCallable<ListJobsRequest,ListJobsResponse> aggregatedListJobsCallable()

List the jobs of a project across all regions.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   while (true) {
     ListJobsResponse response = jobsV1Beta3Client.aggregatedListJobsCallable().call(request);
     for (Job element : response.getJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobsRequest,ListJobsResponse>

aggregatedListJobsPagedCallable()

public final UnaryCallable<ListJobsRequest,JobsV1Beta3Client.AggregatedListJobsPagedResponse> aggregatedListJobsPagedCallable()

List the jobs of a project across all regions.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future =
       jobsV1Beta3Client.aggregatedListJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobsRequest,AggregatedListJobsPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

checkActiveJobs(CheckActiveJobsRequest request)

public final CheckActiveJobsResponse checkActiveJobs(CheckActiveJobsRequest request)

Check for existence of active jobs in the given project across all regions.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   CheckActiveJobsRequest request =
       CheckActiveJobsRequest.newBuilder().setProjectId("projectId-894832108").build();
   CheckActiveJobsResponse response = jobsV1Beta3Client.checkActiveJobs(request);
 }
 

Parameter
Name	Description
request	CheckActiveJobsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
CheckActiveJobsResponse

checkActiveJobsCallable()

public final UnaryCallable<CheckActiveJobsRequest,CheckActiveJobsResponse> checkActiveJobsCallable()

Check for existence of active jobs in the given project across all regions.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   CheckActiveJobsRequest request =
       CheckActiveJobsRequest.newBuilder().setProjectId("projectId-894832108").build();
   ApiFuture<CheckActiveJobsResponse> future =
       jobsV1Beta3Client.checkActiveJobsCallable().futureCall(request);
   // Do something.
   CheckActiveJobsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CheckActiveJobsRequest,CheckActiveJobsResponse>

close()

public final void close()

createJob(CreateJobRequest request)

public final Job createJob(CreateJobRequest request)

Creates a Cloud Dataflow job.

To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJob(Job.newBuilder().build())
           .setView(JobView.forNumber(0))
           .setReplaceJobId("replaceJobId441554788")
           .setLocation("location1901043637")
           .build();
   Job response = jobsV1Beta3Client.createJob(request);
 }
 

Parameter
Name	Description
request	CreateJobRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Job

createJobCallable()

public final UnaryCallable<CreateJobRequest,Job> createJobCallable()

Creates a Cloud Dataflow job.

To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJob(Job.newBuilder().build())
           .setView(JobView.forNumber(0))
           .setReplaceJobId("replaceJobId441554788")
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future = jobsV1Beta3Client.createJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateJobRequest,Job>

getJob(GetJobRequest request)

public final Job getJob(GetJobRequest request)

Gets the state of the specified Cloud Dataflow job.

To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setView(JobView.forNumber(0))
           .setLocation("location1901043637")
           .build();
   Job response = jobsV1Beta3Client.getJob(request);
 }
 

Parameter
Name	Description
request	GetJobRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Job

getJobCallable()

public final UnaryCallable<GetJobRequest,Job> getJobCallable()

Gets the state of the specified Cloud Dataflow job.

To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setView(JobView.forNumber(0))
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future = jobsV1Beta3Client.getJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetJobRequest,Job>

getSettings()

public final JobsV1Beta3Settings getSettings()

Returns
Type	Description
JobsV1Beta3Settings

getStub()

public JobsV1Beta3Stub getStub()

Returns
Type	Description
JobsV1Beta3Stub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listJobs(ListJobsRequest request)

public final JobsV1Beta3Client.ListJobsPagedResponse listJobs(ListJobsRequest request)

List the jobs of a project.

To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, as you can only get the list of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   for (Job element : jobsV1Beta3Client.listJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListJobsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
JobsV1Beta3Client.ListJobsPagedResponse

listJobsCallable()

public final UnaryCallable<ListJobsRequest,ListJobsResponse> listJobsCallable()

List the jobs of a project.

To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, as you can only get the list of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   while (true) {
     ListJobsResponse response = jobsV1Beta3Client.listJobsCallable().call(request);
     for (Job element : response.getJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobsRequest,ListJobsResponse>

listJobsPagedCallable()

public final UnaryCallable<ListJobsRequest,JobsV1Beta3Client.ListJobsPagedResponse> listJobsPagedCallable()

List the jobs of a project.

To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, as you can only get the list of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setView(JobView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future = jobsV1Beta3Client.listJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobsRequest,ListJobsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

snapshotJob(SnapshotJobRequest request)

public final Snapshot snapshotJob(SnapshotJobRequest request)

Snapshot the state of a streaming job.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   SnapshotJobRequest request =
       SnapshotJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setTtl(Duration.newBuilder().build())
           .setLocation("location1901043637")
           .setSnapshotSources(true)
           .setDescription("description-1724546052")
           .build();
   Snapshot response = jobsV1Beta3Client.snapshotJob(request);
 }
 

Parameter
Name	Description
request	SnapshotJobRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Snapshot

snapshotJobCallable()

public final UnaryCallable<SnapshotJobRequest,Snapshot> snapshotJobCallable()

Snapshot the state of a streaming job.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   SnapshotJobRequest request =
       SnapshotJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setTtl(Duration.newBuilder().build())
           .setLocation("location1901043637")
           .setSnapshotSources(true)
           .setDescription("description-1724546052")
           .build();
   ApiFuture<Snapshot> future = jobsV1Beta3Client.snapshotJobCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SnapshotJobRequest,Snapshot>

updateJob(UpdateJobRequest request)

public final Job updateJob(UpdateJobRequest request)

Updates the state of an existing Cloud Dataflow job.

To update the state of an existing job, we recommend using projects.locations.jobs.update with a regional endpoint. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setJob(Job.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   Job response = jobsV1Beta3Client.updateJob(request);
 }
 

Parameter
Name	Description
request	UpdateJobRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Job

updateJobCallable()

public final UnaryCallable<UpdateJobRequest,Job> updateJobCallable()

Updates the state of an existing Cloud Dataflow job.

To update the state of an existing job, we recommend using projects.locations.jobs.update with a regional endpoint. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

Sample code:

 // 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_library
 try (JobsV1Beta3Client jobsV1Beta3Client = JobsV1Beta3Client.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setJob(Job.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future = jobsV1Beta3Client.updateJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateJobRequest,Job>