Class JobsClient (0.35.0)

Version 0.35.0

• 0.53.0 (latest)
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.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.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5
• 0.2.1
• 0.1.2

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

Service Description: Cloud Run Job Control Plane API.

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 (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = jobsClient.getJob(name);
 }
 

Note: close() needs to be called on the JobsClient 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 Job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createJobAsync(CreateJobRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. createJobAsync(LocationName parent, Job job, String jobId) createJobAsync(String parent, Job job, String jobId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createJobOperationCallable() createJobCallable()
GetJob	Gets information about a Job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getJob(GetJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getJob(JobName name) getJob(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getJobCallable()
ListJobs	Lists Jobs.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listJobs(ListJobsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listJobs(LocationName parent) listJobs(String parent) 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()
UpdateJob	Updates a Job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateJobAsync(UpdateJobRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. updateJobAsync(Job job) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateJobOperationCallable() updateJobCallable()
DeleteJob	Deletes a Job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteJobAsync(DeleteJobRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteJobAsync(JobName name) deleteJobAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteJobOperationCallable() deleteJobCallable()
RunJob	Triggers creation of a new Execution of this Job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. runJobAsync(RunJobRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. runJobAsync(JobName name) runJobAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. runJobOperationCallable() runJobCallable()
GetIamPolicy	Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 JobsSettings 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
 JobsSettings jobsSettings =
     JobsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);
 

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
 JobsSettings jobsSettings = JobsSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);
 

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
 JobsSettings jobsSettings = JobsSettings.newHttpJsonBuilder().build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);
 

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

Inheritance

java.lang.Object > JobsClient

Static Methods

create()

public static final JobsClient create()

Constructs an instance of JobsClient with default settings.

Returns
Type	Description
JobsClient

Exceptions
Type	Description
IOException

create(JobsSettings settings)

public static final JobsClient create(JobsSettings settings)

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

Returns
Type	Description
JobsClient

Exceptions
Type	Description
IOException

create(JobsStub stub)

public static final JobsClient create(JobsStub stub)

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

Parameter
Name	Description
stub	JobsStub

Returns
Type	Description
JobsClient

Constructors

JobsClient(JobsSettings settings)

protected JobsClient(JobsSettings settings)

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

JobsClient(JobsStub stub)

protected JobsClient(JobsStub stub)

Parameter
Name	Description
stub	JobsStub

Methods

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

close()

public final void close()

createJobAsync(CreateJobRequest request)

public final OperationFuture<Job,Job> createJobAsync(CreateJobRequest request)

Creates a 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 (JobsClient jobsClient = JobsClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .setJobId("jobId101296568")
           .setValidateOnly(true)
           .build();
   Job response = jobsClient.createJobAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Job,Job>

createJobAsync(LocationName parent, Job job, String jobId)

public final OperationFuture<Job,Job> createJobAsync(LocationName parent, Job job, String jobId)

Creates a 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 (JobsClient jobsClient = JobsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   String jobId = "jobId101296568";
   Job response = jobsClient.createJobAsync(parent, job, jobId).get();
 }
 

Parameters
Name	Description
parent	LocationName Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
job	Job Required. The Job instance to create.
jobId	String Required. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}.

Returns
Type	Description
OperationFuture<Job,Job>

createJobAsync(String parent, Job job, String jobId)

public final OperationFuture<Job,Job> createJobAsync(String parent, Job job, String jobId)

Creates a 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 (JobsClient jobsClient = JobsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Job job = Job.newBuilder().build();
   String jobId = "jobId101296568";
   Job response = jobsClient.createJobAsync(parent, job, jobId).get();
 }
 

Parameters
Name	Description
parent	String Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
job	Job Required. The Job instance to create.
jobId	String Required. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}.

Returns
Type	Description
OperationFuture<Job,Job>

createJobCallable()

public final UnaryCallable<CreateJobRequest,Operation> createJobCallable()

Creates a 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 (JobsClient jobsClient = JobsClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .setJobId("jobId101296568")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = jobsClient.createJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateJobRequest,Operation>

createJobOperationCallable()

public final OperationCallable<CreateJobRequest,Job,Job> createJobOperationCallable()

Creates a 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 (JobsClient jobsClient = JobsClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .setJobId("jobId101296568")
           .setValidateOnly(true)
           .build();
   OperationFuture<Job, Job> future =
       jobsClient.createJobOperationCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateJobRequest,Job,Job>

deleteJobAsync(DeleteJobRequest request)

public final OperationFuture<Job,Job> deleteJobAsync(DeleteJobRequest request)

Deletes a 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 (JobsClient jobsClient = JobsClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Job response = jobsClient.deleteJobAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Job,Job>

deleteJobAsync(JobName name)

public final OperationFuture<Job,Job> deleteJobAsync(JobName name)

Deletes a 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 (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = jobsClient.deleteJobAsync(name).get();
 }
 

Parameter
Name	Description
name	JobName Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
OperationFuture<Job,Job>

deleteJobAsync(String name)

public final OperationFuture<Job,Job> deleteJobAsync(String name)

Deletes a 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 (JobsClient jobsClient = JobsClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = jobsClient.deleteJobAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
OperationFuture<Job,Job>

deleteJobCallable()

public final UnaryCallable<DeleteJobRequest,Operation> deleteJobCallable()

Deletes a 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 (JobsClient jobsClient = JobsClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = jobsClient.deleteJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteJobRequest,Operation>

deleteJobOperationCallable()

public final OperationCallable<DeleteJobRequest,Job,Job> deleteJobOperationCallable()

Deletes a 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 (JobsClient jobsClient = JobsClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Job, Job> future =
       jobsClient.deleteJobOperationCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteJobRequest,Job,Job>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature 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.

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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 (JobsClient jobsClient = JobsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = jobsClient.getIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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 (JobsClient jobsClient = JobsClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = jobsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getJob(GetJobRequest request)

public final Job getJob(GetJobRequest request)

Gets information about a 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 (JobsClient jobsClient = JobsClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   Job response = jobsClient.getJob(request);
 }
 

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

Returns
Type	Description
Job

getJob(JobName name)

public final Job getJob(JobName name)

Gets information about a 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 (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = jobsClient.getJob(name);
 }
 

Parameter
Name	Description
name	JobName Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
Job

getJob(String name)

public final Job getJob(String name)

Gets information about a 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 (JobsClient jobsClient = JobsClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = jobsClient.getJob(name);
 }
 

Parameter
Name	Description
name	String Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
Job

getJobCallable()

public final UnaryCallable<GetJobRequest,Job> getJobCallable()

Gets information about a 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 (JobsClient jobsClient = JobsClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = jobsClient.getJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetJobRequest,Job>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getSettings()

public final JobsSettings getSettings()

Returns
Type	Description
JobsSettings

getStub()

public JobsStub getStub()

Returns
Type	Description
JobsStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listJobs(ListJobsRequest request)

public final JobsClient.ListJobsPagedResponse listJobs(ListJobsRequest request)

Lists Jobs.

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 (JobsClient jobsClient = JobsClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Job element : jobsClient.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
JobsClient.ListJobsPagedResponse

listJobs(LocationName parent)

public final JobsClient.ListJobsPagedResponse listJobs(LocationName parent)

Lists Jobs.

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 (JobsClient jobsClient = JobsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Job element : jobsClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns
Type	Description
JobsClient.ListJobsPagedResponse

listJobs(String parent)

public final JobsClient.ListJobsPagedResponse listJobs(String parent)

Lists Jobs.

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 (JobsClient jobsClient = JobsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Job element : jobsClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns
Type	Description
JobsClient.ListJobsPagedResponse

listJobsCallable()

public final UnaryCallable<ListJobsRequest,ListJobsResponse> listJobsCallable()

Lists Jobs.

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 (JobsClient jobsClient = JobsClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListJobsResponse response = jobsClient.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,JobsClient.ListJobsPagedResponse> listJobsPagedCallable()

Lists Jobs.

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 (JobsClient jobsClient = JobsClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Job> future = jobsClient.listJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobsRequest,ListJobsPagedResponse>

runJobAsync(JobName name)

public final OperationFuture<Execution,Execution> runJobAsync(JobName name)

Triggers creation of a new Execution of this 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 (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Execution response = jobsClient.runJobAsync(name).get();
 }
 

Parameter
Name	Description
name	JobName Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
OperationFuture<Execution,Execution>

runJobAsync(RunJobRequest request)

public final OperationFuture<Execution,Execution> runJobAsync(RunJobRequest request)

Triggers creation of a new Execution of this 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 (JobsClient jobsClient = JobsClient.create()) {
   RunJobRequest request =
       RunJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .setOverrides(RunJobRequest.Overrides.newBuilder().build())
           .build();
   Execution response = jobsClient.runJobAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Execution,Execution>

runJobAsync(String name)

public final OperationFuture<Execution,Execution> runJobAsync(String name)

Triggers creation of a new Execution of this 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 (JobsClient jobsClient = JobsClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Execution response = jobsClient.runJobAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type	Description
OperationFuture<Execution,Execution>

runJobCallable()

public final UnaryCallable<RunJobRequest,Operation> runJobCallable()

Triggers creation of a new Execution of this 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 (JobsClient jobsClient = JobsClient.create()) {
   RunJobRequest request =
       RunJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .setOverrides(RunJobRequest.Overrides.newBuilder().build())
           .build();
   ApiFuture<Operation> future = jobsClient.runJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<RunJobRequest,Operation>

runJobOperationCallable()

public final OperationCallable<RunJobRequest,Execution,Execution> runJobOperationCallable()

Triggers creation of a new Execution of this 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 (JobsClient jobsClient = JobsClient.create()) {
   RunJobRequest request =
       RunJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .setOverrides(RunJobRequest.Overrides.newBuilder().build())
           .build();
   OperationFuture<Execution, Execution> future =
       jobsClient.runJobOperationCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }
 

Returns
Type	Description
OperationCallable<RunJobRequest,Execution,Execution>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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 (JobsClient jobsClient = JobsClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = jobsClient.setIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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 (JobsClient jobsClient = JobsClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = jobsClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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 (JobsClient jobsClient = JobsClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = jobsClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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 (JobsClient jobsClient = JobsClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       jobsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateJobAsync(Job job)

public final OperationFuture<Job,Job> updateJobAsync(Job job)

Updates a 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 (JobsClient jobsClient = JobsClient.create()) {
   Job job = Job.newBuilder().build();
   Job response = jobsClient.updateJobAsync(job).get();
 }
 

Parameter
Name	Description
job	Job Required. The Job to be updated.

Returns
Type	Description
OperationFuture<Job,Job>

updateJobAsync(UpdateJobRequest request)

public final OperationFuture<Job,Job> updateJobAsync(UpdateJobRequest request)

Updates a 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 (JobsClient jobsClient = JobsClient.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setJob(Job.newBuilder().build())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   Job response = jobsClient.updateJobAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Job,Job>

updateJobCallable()

public final UnaryCallable<UpdateJobRequest,Operation> updateJobCallable()

Updates a 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 (JobsClient jobsClient = JobsClient.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setJob(Job.newBuilder().build())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future = jobsClient.updateJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateJobRequest,Operation>

updateJobOperationCallable()

public final OperationCallable<UpdateJobRequest,Job,Job> updateJobOperationCallable()

Updates a 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 (JobsClient jobsClient = JobsClient.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setJob(Job.newBuilder().build())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   OperationFuture<Job, Job> future =
       jobsClient.updateJobOperationCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateJobRequest,Job,Job>