JobServiceClient (Google Cloud Talent Solution Parent 2.4.6 API)

java.lang.Object
- com.google.cloud.talent.v4.JobServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class JobServiceClient
extends Object
implements BackgroundResource

Service Description: A service handles job management, including job CRUD, enumeration and search.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Job job = Job.newBuilder().build();
   Job response = jobServiceClient.createJob(parent, job);
 }

Note: close() needs to be called on the JobServiceClient 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 JobServiceSettings 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
 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);

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
 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);

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
 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder()
         .setTransportChannelProvider(
             JobServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobServiceClient.ListJobsFixedSizeCollection`
`static class`	`JobServiceClient.ListJobsPage`
`static class`	`JobServiceClient.ListJobsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`JobServiceClient(JobServiceSettings settings)` Constructs an instance of JobServiceClient, using the given settings.
`protected`	`JobServiceClient(JobServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`OperationFuture<BatchCreateJobsResponse,BatchOperationMetadata>`	`batchCreateJobsAsync(BatchCreateJobsRequest request)` Begins executing a batch create jobs operation.
`OperationFuture<BatchCreateJobsResponse,BatchOperationMetadata>`	`batchCreateJobsAsync(String parent, List<Job> jobs)` Begins executing a batch create jobs operation.
`OperationFuture<BatchCreateJobsResponse,BatchOperationMetadata>`	`batchCreateJobsAsync(TenantName parent, List<Job> jobs)` Begins executing a batch create jobs operation.
`UnaryCallable<BatchCreateJobsRequest,Operation>`	`batchCreateJobsCallable()` Begins executing a batch create jobs operation.
`OperationCallable<BatchCreateJobsRequest,BatchCreateJobsResponse,BatchOperationMetadata>`	`batchCreateJobsOperationCallable()` Begins executing a batch create jobs operation.
`OperationFuture<BatchDeleteJobsResponse,BatchOperationMetadata>`	`batchDeleteJobsAsync(BatchDeleteJobsRequest request)` Begins executing a batch delete jobs operation.
`OperationFuture<BatchDeleteJobsResponse,BatchOperationMetadata>`	`batchDeleteJobsAsync(String parent, List<String> names)` Begins executing a batch delete jobs operation.
`OperationFuture<BatchDeleteJobsResponse,BatchOperationMetadata>`	`batchDeleteJobsAsync(TenantName parent, List<String> names)` Begins executing a batch delete jobs operation.
`UnaryCallable<BatchDeleteJobsRequest,Operation>`	`batchDeleteJobsCallable()` Begins executing a batch delete jobs operation.
`OperationCallable<BatchDeleteJobsRequest,BatchDeleteJobsResponse,BatchOperationMetadata>`	`batchDeleteJobsOperationCallable()` Begins executing a batch delete jobs operation.
`OperationFuture<BatchUpdateJobsResponse,BatchOperationMetadata>`	`batchUpdateJobsAsync(BatchUpdateJobsRequest request)` Begins executing a batch update jobs operation.
`OperationFuture<BatchUpdateJobsResponse,BatchOperationMetadata>`	`batchUpdateJobsAsync(String parent, List<Job> jobs)` Begins executing a batch update jobs operation.
`OperationFuture<BatchUpdateJobsResponse,BatchOperationMetadata>`	`batchUpdateJobsAsync(TenantName parent, List<Job> jobs)` Begins executing a batch update jobs operation.
`UnaryCallable<BatchUpdateJobsRequest,Operation>`	`batchUpdateJobsCallable()` Begins executing a batch update jobs operation.
`OperationCallable<BatchUpdateJobsRequest,BatchUpdateJobsResponse,BatchOperationMetadata>`	`batchUpdateJobsOperationCallable()` Begins executing a batch update jobs operation.
`void`	`close()`
`static JobServiceClient`	`create()` Constructs an instance of JobServiceClient with default settings.
`static JobServiceClient`	`create(JobServiceSettings settings)` Constructs an instance of JobServiceClient, using the given settings.
`static JobServiceClient`	`create(JobServiceStub stub)` Constructs an instance of JobServiceClient, using the given stub for making calls.
`Job`	`createJob(CreateJobRequest request)` Creates a new job.
`Job`	`createJob(String parent, Job job)` Creates a new job.
`Job`	`createJob(TenantName parent, Job job)` Creates a new job.
`UnaryCallable<CreateJobRequest,Job>`	`createJobCallable()` Creates a new job.
`void`	`deleteJob(DeleteJobRequest request)` Deletes the specified job.
`void`	`deleteJob(JobName name)` Deletes the specified job.
`void`	`deleteJob(String name)` Deletes the specified job.
`UnaryCallable<DeleteJobRequest,Empty>`	`deleteJobCallable()` Deletes the specified job.
`OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Job`	`getJob(GetJobRequest request)` Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
`Job`	`getJob(JobName name)` Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
`Job`	`getJob(String name)` Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
`UnaryCallable<GetJobRequest,Job>`	`getJobCallable()` Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`JobServiceSettings`	`getSettings()`
`JobServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`JobServiceClient.ListJobsPagedResponse`	`listJobs(ListJobsRequest request)` Lists jobs by filter.
`JobServiceClient.ListJobsPagedResponse`	`listJobs(String parent, String filter)` Lists jobs by filter.
`JobServiceClient.ListJobsPagedResponse`	`listJobs(TenantName parent, String filter)` Lists jobs by filter.
`UnaryCallable<ListJobsRequest,ListJobsResponse>`	`listJobsCallable()` Lists jobs by filter.
`UnaryCallable<ListJobsRequest,JobServiceClient.ListJobsPagedResponse>`	`listJobsPagedCallable()` Lists jobs by filter.
`SearchJobsResponse`	`searchJobs(SearchJobsRequest request)` Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
`UnaryCallable<SearchJobsRequest,SearchJobsResponse>`	`searchJobsCallable()` Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
`SearchJobsResponse`	`searchJobsForAlert(SearchJobsRequest request)` Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
`UnaryCallable<SearchJobsRequest,SearchJobsResponse>`	`searchJobsForAlertCallable()` Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
`void`	`shutdown()`
`void`	`shutdownNow()`
`Job`	`updateJob(Job job, FieldMask updateMask)` Updates specified job.
`Job`	`updateJob(UpdateJobRequest request)` Updates specified job.
`UnaryCallable<UpdateJobRequest,Job>`	`updateJobCallable()` Updates specified job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- JobServiceClient
```
protected JobServiceClient(JobServiceSettings settings)
                    throws IOException
```
  Constructs an instance of JobServiceClient, 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
- JobServiceClient
```
protected JobServiceClient(JobServiceStub stub)
```

Method Detail

create

public static final JobServiceClient create()
                                     throws IOException

Constructs an instance of JobServiceClient with default settings.

Throws:: IOException

create
```
public static final JobServiceClient create(JobServiceSettings settings)
                                     throws IOException
```
Constructs an instance of JobServiceClient, 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 JobServiceClient create(JobServiceStub stub)
```
Constructs an instance of JobServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(JobServiceSettings).

getSettings

public final JobServiceSettings getSettings()

getStub
```
public JobServiceStub getStub()
```

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.

getHttpJsonOperationsClient
```
@BetaApi
public final OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createJob

public final Job createJob(TenantName parent,
                           Job job)

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Job job = Job.newBuilder().build();
   Job response = jobServiceClient.createJob(parent, job);
 }

Parameters:: parent - Required. The resource name of the tenant under which the job is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".; job - Required. The Job to be created.
Throws:: ApiException - if the remote call fails

createJob

public final Job createJob(String parent,
                           Job job)

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = TenantName.of("[PROJECT]", "[TENANT]").toString();
   Job job = Job.newBuilder().build();
   Job response = jobServiceClient.createJob(parent, job);
 }

Parameters:: parent - Required. The resource name of the tenant under which the job is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".; job - Required. The Job to be created.
Throws:: ApiException - if the remote call fails

createJob

public final Job createJob(CreateJobRequest request)

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   Job response = jobServiceClient.createJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createJobCallable

public final UnaryCallable<CreateJobRequest,Job> createJobCallable()

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   ApiFuture<Job> future = jobServiceClient.createJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }