com.google.cloud.dataproc.v1beta2

Class JobControllerClient

java.lang.Object

com.google.cloud.dataproc.v1beta2.JobControllerClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class JobControllerClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The JobController provides methods to manage jobs.

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:

 
 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   Job job = Job.newBuilder().build();
   Job response = jobControllerClient.submitJob(projectId, region, job);
 }
 
 

Note: close() needs to be called on the jobControllerClient 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:

1. 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.
2. 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.
3. 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 JobControllerSettings to create(). For example:

To customize credentials:

 
 JobControllerSettings jobControllerSettings =
     JobControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobControllerClient jobControllerClient =
     JobControllerClient.create(jobControllerSettings);
 
 

To customize the endpoint:

 
 JobControllerSettings jobControllerSettings =
     JobControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobControllerClient jobControllerClient =
     JobControllerClient.create(jobControllerSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobControllerClient.ListJobsFixedSizeCollection
static class	JobControllerClient.ListJobsPage
static class	JobControllerClient.ListJobsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobControllerClient(JobControllerSettings settings) Constructs an instance of JobControllerClient, using the given settings.
protected	JobControllerClient(JobControllerStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
Job	cancelJob(CancelJobRequest request) Starts a job cancellation request.
Job	cancelJob(String projectId, String region, String jobId) Starts a job cancellation request.
com.google.api.gax.rpc.UnaryCallable<CancelJobRequest,Job>	cancelJobCallable() Starts a job cancellation request.
void	close()
static JobControllerClient	create() Constructs an instance of JobControllerClient with default settings.
static JobControllerClient	create(JobControllerSettings settings) Constructs an instance of JobControllerClient, using the given settings.
static JobControllerClient	create(JobControllerStub stub) Constructs an instance of JobControllerClient, using the given stub for making calls.
void	deleteJob(DeleteJobRequest request) Deletes the job from the project.
void	deleteJob(String projectId, String region, String jobId) Deletes the job from the project.
com.google.api.gax.rpc.UnaryCallable<DeleteJobRequest,Empty>	deleteJobCallable() Deletes the job from the project.
Job	getJob(GetJobRequest request) Gets the resource representation for a job in a project.
Job	getJob(String projectId, String region, String jobId) Gets the resource representation for a job in a project.
com.google.api.gax.rpc.UnaryCallable<GetJobRequest,Job>	getJobCallable() Gets the resource representation for a job in a project.
JobControllerSettings	getSettings()
JobControllerStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
JobControllerClient.ListJobsPagedResponse	listJobs(ListJobsRequest request) Lists regions/{region}/jobs in a project.
JobControllerClient.ListJobsPagedResponse	listJobs(String projectId, String region) Lists regions/{region}/jobs in a project.
JobControllerClient.ListJobsPagedResponse	listJobs(String projectId, String region, String filter) Lists regions/{region}/jobs in a project.
com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse>	listJobsCallable() Lists regions/{region}/jobs in a project.
com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,JobControllerClient.ListJobsPagedResponse>	listJobsPagedCallable() Lists regions/{region}/jobs in a project.
void	shutdown()
void	shutdownNow()
Job	submitJob(String projectId, String region, Job job) Submits a job to a cluster.
Job	submitJob(SubmitJobRequest request) Submits a job to a cluster.
com.google.api.gax.rpc.UnaryCallable<SubmitJobRequest,Job>	submitJobCallable() Submits a job to a cluster.
Job	updateJob(UpdateJobRequest request) Updates a job in a project.
com.google.api.gax.rpc.UnaryCallable<UpdateJobRequest,Job>	updateJobCallable() Updates a job in a project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobControllerClient

protected JobControllerClient(JobControllerSettings settings)
                       throws IOException

Constructs an instance of JobControllerClient, 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

JobControllerClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected JobControllerClient(JobControllerStub stub)

Method Detail

create

public static final JobControllerClient create()
                                        throws IOException

Constructs an instance of JobControllerClient with default settings.

Throws:

IOException

create

public static final JobControllerClient create(JobControllerSettings settings)
                                        throws IOException

Constructs an instance of JobControllerClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final JobControllerClient create(JobControllerStub stub)

Constructs an instance of JobControllerClient, using the given stub for making calls. This is for advanced usage - prefer to use JobControllerSettings}.

getSettings

public final JobControllerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public JobControllerStub getStub()

submitJob

public final Job submitJob(String projectId,
                           String region,
                           Job job)

Submits a job to a cluster.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   Job job = Job.newBuilder().build();
   Job response = jobControllerClient.submitJob(projectId, region, job);
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

job - Required. The job resource.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

submitJob

public final Job submitJob(SubmitJobRequest request)

Submits a job to a cluster.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   Job job = Job.newBuilder().build();
   SubmitJobRequest request = SubmitJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJob(job)
     .build();
   Job response = jobControllerClient.submitJob(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

submitJobCallable

public final com.google.api.gax.rpc.UnaryCallable<SubmitJobRequest,Job> submitJobCallable()

Submits a job to a cluster.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   Job job = Job.newBuilder().build();
   SubmitJobRequest request = SubmitJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJob(job)
     .build();
   ApiFuture<Job> future = jobControllerClient.submitJobCallable().futureCall(request);
   // Do something
   Job response = future.get();
 }
 

getJob

public final Job getJob(String projectId,
                        String region,
                        String jobId)

Gets the resource representation for a job in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   Job response = jobControllerClient.getJob(projectId, region, jobId);
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

jobId - Required. The job ID.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getJob

public final Job getJob(GetJobRequest request)

Gets the resource representation for a job in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   GetJobRequest request = GetJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   Job response = jobControllerClient.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 resource representation for a job in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   GetJobRequest request = GetJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   ApiFuture<Job> future = jobControllerClient.getJobCallable().futureCall(request);
   // Do something
   Job response = future.get();
 }
 

listJobs

public final JobControllerClient.ListJobsPagedResponse listJobs(String projectId,
                                                                String region)

Lists regions/{region}/jobs in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   for (Job element : jobControllerClient.listJobs(projectId, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listJobs

public final JobControllerClient.ListJobsPagedResponse listJobs(String projectId,
                                                                String region,
                                                                String filter)

Lists regions/{region}/jobs in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String filter = "";
   for (Job element : jobControllerClient.listJobs(projectId, region, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

filter - Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:

[field = value] AND [field [= value]] ...

where **field** is `status.state` or `labels.[KEY]`, and `[KEY]` is a label key. **value** can be `*` to match all values. `status.state` can be either `ACTIVE` or `NON_ACTIVE`. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator.

Example filter:

status.state = ACTIVE AND labels.env = staging AND labels.starred = *

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listJobs

public final JobControllerClient.ListJobsPagedResponse listJobs(ListJobsRequest request)

Lists regions/{region}/jobs in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListJobsRequest request = ListJobsRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .build();
   for (Job element : jobControllerClient.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,JobControllerClient.ListJobsPagedResponse> listJobsPagedCallable()

Lists regions/{region}/jobs in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListJobsRequest request = ListJobsRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .build();
   ApiFuture<ListJobsPagedResponse> future = jobControllerClient.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()

Lists regions/{region}/jobs in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListJobsRequest request = ListJobsRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .build();
   while (true) {
     ListJobsResponse response = jobControllerClient.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;
     }
   }
 }
 

updateJob

public final Job updateJob(UpdateJobRequest request)

Updates a job in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   Job job = Job.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateJobRequest request = UpdateJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .setJob(job)
     .setUpdateMask(updateMask)
     .build();
   Job response = jobControllerClient.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 a job in a project.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   Job job = Job.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateJobRequest request = UpdateJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .setJob(job)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Job> future = jobControllerClient.updateJobCallable().futureCall(request);
   // Do something
   Job response = future.get();
 }
 

cancelJob

public final Job cancelJob(String projectId,
                           String region,
                           String jobId)

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   Job response = jobControllerClient.cancelJob(projectId, region, jobId);
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

jobId - Required. The job ID.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

cancelJob

public final Job cancelJob(CancelJobRequest request)

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   CancelJobRequest request = CancelJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   Job response = jobControllerClient.cancelJob(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

cancelJobCallable

public final com.google.api.gax.rpc.UnaryCallable<CancelJobRequest,Job> cancelJobCallable()

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   CancelJobRequest request = CancelJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   ApiFuture<Job> future = jobControllerClient.cancelJobCallable().futureCall(request);
   // Do something
   Job response = future.get();
 }
 

deleteJob

public final void deleteJob(String projectId,
                            String region,
                            String jobId)

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   jobControllerClient.deleteJob(projectId, region, jobId);
 }
 

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Cloud Dataproc region in which to handle the request.

jobId - Required. The job ID.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteJob

public final void deleteJob(DeleteJobRequest request)

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   DeleteJobRequest request = DeleteJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   jobControllerClient.deleteJob(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

deleteJobCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteJobRequest,Empty> deleteJobCallable()

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Sample code:

 try (JobControllerClient jobControllerClient = JobControllerClient.create()) {
   String projectId = "";
   String region = "";
   String jobId = "";
   DeleteJobRequest request = DeleteJobRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setJobId(jobId)
     .build();
   ApiFuture<Void> future = jobControllerClient.deleteJobCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException