Class JobsV1Beta3Client
- java.lang.Object
-
- com.google.dataflow.v1beta3.JobsV1Beta3Client
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class JobsV1Beta3Client extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
JobsV1Beta3Client.AggregatedListJobsFixedSizeCollection
static class
JobsV1Beta3Client.AggregatedListJobsPage
static class
JobsV1Beta3Client.AggregatedListJobsPagedResponse
static class
JobsV1Beta3Client.ListJobsFixedSizeCollection
static class
JobsV1Beta3Client.ListJobsPage
static class
JobsV1Beta3Client.ListJobsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
JobsV1Beta3Client(JobsV1Beta3Settings settings)
Constructs an instance of JobsV1Beta3Client, using the given settings.protected
JobsV1Beta3Client(JobsV1Beta3Stub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description JobsV1Beta3Client.AggregatedListJobsPagedResponse
aggregatedListJobs(ListJobsRequest request)
List the jobs of a project across all regions.com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse>
aggregatedListJobsCallable()
List the jobs of a project across all regions.com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,JobsV1Beta3Client.AggregatedListJobsPagedResponse>
aggregatedListJobsPagedCallable()
List the jobs of a project across all regions.boolean
awaitTermination(long duration, TimeUnit unit)
CheckActiveJobsResponse
checkActiveJobs(CheckActiveJobsRequest request)
Check for existence of active jobs in the given project across all regions.com.google.api.gax.rpc.UnaryCallable<CheckActiveJobsRequest,CheckActiveJobsResponse>
checkActiveJobsCallable()
Check for existence of active jobs in the given project across all regions.void
close()
static JobsV1Beta3Client
create()
Constructs an instance of JobsV1Beta3Client with default settings.static JobsV1Beta3Client
create(JobsV1Beta3Settings settings)
Constructs an instance of JobsV1Beta3Client, using the given settings.static JobsV1Beta3Client
create(JobsV1Beta3Stub stub)
Constructs an instance of JobsV1Beta3Client, using the given stub for making calls.Job
createJob(CreateJobRequest request)
Creates a Cloud Dataflow job.com.google.api.gax.rpc.UnaryCallable<CreateJobRequest,Job>
createJobCallable()
Creates a Cloud Dataflow job.Job
getJob(GetJobRequest request)
Gets the state of the specified Cloud Dataflow job.com.google.api.gax.rpc.UnaryCallable<GetJobRequest,Job>
getJobCallable()
Gets the state of the specified Cloud Dataflow job.JobsV1Beta3Settings
getSettings()
JobsV1Beta3Stub
getStub()
boolean
isShutdown()
boolean
isTerminated()
JobsV1Beta3Client.ListJobsPagedResponse
listJobs(ListJobsRequest request)
List the jobs of a project.com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse>
listJobsCallable()
List the jobs of a project.com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,JobsV1Beta3Client.ListJobsPagedResponse>
listJobsPagedCallable()
List the jobs of a project.void
shutdown()
void
shutdownNow()
Snapshot
snapshotJob(SnapshotJobRequest request)
Snapshot the state of a streaming job.com.google.api.gax.rpc.UnaryCallable<SnapshotJobRequest,Snapshot>
snapshotJobCallable()
Snapshot the state of a streaming job.Job
updateJob(UpdateJobRequest request)
Updates the state of an existing Cloud Dataflow job.com.google.api.gax.rpc.UnaryCallable<UpdateJobRequest,Job>
updateJobCallable()
Updates the state of an existing Cloud Dataflow job.
-
-
-
Constructor Detail
-
JobsV1Beta3Client
protected JobsV1Beta3Client(JobsV1Beta3Settings settings) throws IOException
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.- Throws:
IOException
-
JobsV1Beta3Client
protected JobsV1Beta3Client(JobsV1Beta3Stub stub)
-
-
Method Detail
-
create
public static final JobsV1Beta3Client create() throws IOException
Constructs an instance of JobsV1Beta3Client with default settings.- Throws:
IOException
-
create
public static final JobsV1Beta3Client create(JobsV1Beta3Settings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final JobsV1Beta3Settings getSettings()
-
getStub
public JobsV1Beta3Stub getStub()
-
createJob
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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createJobCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateJobRequest,Job> createJobCallable()
Creates a Cloud Dataflow job.To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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(); }
-
getJob
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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getJobCallable
public final com.google.api.gax.rpc.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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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(); }
-
updateJob
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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateJobCallable
public final com.google.api.gax.rpc.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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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(); }
-
listJobs
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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listJobsPagedCallable
public final com.google.api.gax.rpc.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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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); } }
-
listJobsCallable
public final com.google.api.gax.rpc.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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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; } } }
-
aggregatedListJobs
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedListJobsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
aggregatedListJobsCallable
public final com.google.api.gax.rpc.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; } } }
-
checkActiveJobs
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
checkActiveJobsCallable
public final com.google.api.gax.rpc.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(); }
-
snapshotJob
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
snapshotJobCallable
public final com.google.api.gax.rpc.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-