Class JobServiceClient (2.28.0)

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

JobServiceClient(JobServiceClient const &)

Copy and move support

Parameter
Name	Description
	`JobServiceClient const &`

JobServiceClient(JobServiceClient &&)

Copy and move support

Parameter
Name	Description
	`JobServiceClient &&`

JobServiceClient(std::shared_ptr< JobServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< JobServiceConnection >`
`opts`	`Options`

Operators

operator=(JobServiceClient const &)

Copy and move support

Parameter
Name	Description
	`JobServiceClient const &`

Returns
Type	Description
`JobServiceClient &`

operator=(JobServiceClient &&)

Copy and move support

Parameter
Name	Description
	`JobServiceClient &&`

Returns
Type	Description
`JobServiceClient &`

Functions

CreateJob(std::string const &, google::cloud::talent::v4::Job const &, Options)

Creates a new job.

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

Parameters
Name	Description
`parent`	`std::string const &` 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`	`google::cloud::talent::v4::Job const &` Required. The Job to be created.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateJob(google::cloud::talent::v4::CreateJobRequest const &, Options)

Creates a new job.

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

Parameters
Name	Description
`request`	`google::cloud::talent::v4::CreateJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.CreateJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

BatchCreateJobs(std::string const &, std::vector< google::cloud::talent::v4::Job > const &, Options)

Begins executing a batch create jobs operation.

Parameters
Name	Description
`parent`	`std::string const &` 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".
`jobs`	`std::vector< google::cloud::talent::v4::Job > const &` Required. The jobs to be created. A maximum of 200 jobs can be created in a batch.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchCreateJobsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.talent.v4.BatchCreateJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateJobs(NoAwaitTag, std::string const &, std::vector< google::cloud::talent::v4::Job > const &, Options)

Begins executing a batch create jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`jobs`	`std::vector< google::cloud::talent::v4::Job > const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchCreateJobs(google::cloud::talent::v4::BatchCreateJobsRequest const &, Options)

Begins executing a batch create jobs operation.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::BatchCreateJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.BatchCreateJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchCreateJobsResponse > >

BatchCreateJobs(NoAwaitTag, google::cloud::talent::v4::BatchCreateJobsRequest const &, Options)

Begins executing a batch create jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::talent::v4::BatchCreateJobsRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchCreateJobs(google::longrunning::Operation const &, Options)

Begins executing a batch create jobs operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::talent::v4::BatchCreateJobsResponse > >`

GetJob(std::string const &, Options)

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the job to retrieve. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJob(google::cloud::talent::v4::GetJobRequest const &, Options)

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::GetJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.GetJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateJob(google::cloud::talent::v4::Job const &, google::protobuf::FieldMask const &, Options)

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Parameters
Name	Description
`job`	`google::cloud::talent::v4::Job const &` Required. The Job to be updated.
`update_mask`	`google::protobuf::FieldMask const &` Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateJob(google::cloud::talent::v4::UpdateJobRequest const &, Options)

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::UpdateJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.UpdateJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::Job >`	the result of the RPC. The response message type (google.cloud.talent.v4.Job) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

BatchUpdateJobs(std::string const &, std::vector< google::cloud::talent::v4::Job > const &, Options)

Begins executing a batch update jobs operation.

Parameters
Name	Description
`parent`	`std::string const &` 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".
`jobs`	`std::vector< google::cloud::talent::v4::Job > const &` Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchUpdateJobsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.talent.v4.BatchUpdateJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateJobs(NoAwaitTag, std::string const &, std::vector< google::cloud::talent::v4::Job > const &, Options)

Begins executing a batch update jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`jobs`	`std::vector< google::cloud::talent::v4::Job > const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchUpdateJobs(google::cloud::talent::v4::BatchUpdateJobsRequest const &, Options)

Begins executing a batch update jobs operation.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::BatchUpdateJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.BatchUpdateJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchUpdateJobsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.talent.v4.BatchUpdateJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateJobs(NoAwaitTag, google::cloud::talent::v4::BatchUpdateJobsRequest const &, Options)

Begins executing a batch update jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::talent::v4::BatchUpdateJobsRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchUpdateJobs(google::longrunning::Operation const &, Options)

Begins executing a batch update jobs operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::talent::v4::BatchUpdateJobsResponse > >`

DeleteJob(std::string const &, Options)

Deletes the specified job.

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

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the job to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteJob(google::cloud::talent::v4::DeleteJobRequest const &, Options)

Deletes the specified job.

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

Parameters
Name	Description
`request`	`google::cloud::talent::v4::DeleteJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.DeleteJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

BatchDeleteJobs(std::string const &, std::vector< std::string > const &, Options)

Begins executing a batch delete jobs operation.

Parameters
Name	Description
`parent`	`std::string const &` 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". The parent of all of the jobs specified in `names` must match this field.
`names`	`std::vector< std::string > const &` The names of the jobs to delete. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". A maximum of 200 jobs can be deleted in a batch.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchDeleteJobsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.talent.v4.BatchDeleteJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteJobs(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Begins executing a batch delete jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`names`	`std::vector< std::string > const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchDeleteJobs(google::cloud::talent::v4::BatchDeleteJobsRequest const &, Options)

Begins executing a batch delete jobs operation.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::BatchDeleteJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.BatchDeleteJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::talent::v4::BatchDeleteJobsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.talent.v4.BatchDeleteJobsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteJobs(NoAwaitTag, google::cloud::talent::v4::BatchDeleteJobsRequest const &, Options)

Begins executing a batch delete jobs operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::talent::v4::BatchDeleteJobsRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchDeleteJobs(google::longrunning::Operation const &, Options)

Begins executing a batch delete jobs operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::talent::v4::BatchDeleteJobsResponse > >`

ListJobs(std::string const &, std::string const &, Options)

Lists jobs by filter.

Parameters
Name	Description
`parent`	`std::string const &` 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".
`filter`	`std::string const &` Required. The filter string specifies the jobs to be enumerated. For more information, see ListJobsRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::talent::v4::Job >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.talent.v4.Job, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListJobs(google::cloud::talent::v4::ListJobsRequest, Options)

Lists jobs by filter.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::ListJobsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.ListJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::talent::v4::Job >

SearchJobs(google::cloud::talent::v4::SearchJobsRequest const &, Options)

Searches for jobs using the provided SearchJobsRequest.

This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::SearchJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.SearchJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::SearchJobsResponse >`	the result of the RPC. The response message type (google.cloud.talent.v4.SearchJobsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SearchJobsForAlert(google::cloud::talent::v4::SearchJobsRequest const &, Options)

Searches for jobs using the provided SearchJobsRequest.

This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), it has different algorithmic adjustments that are designed to specifically target passive job seekers.

This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.

Parameters
Name	Description
`request`	`google::cloud::talent::v4::SearchJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.talent.v4.SearchJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::talent::v4::SearchJobsResponse >`	the result of the RPC. The response message type (google.cloud.talent.v4.SearchJobsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.