Class JobServiceAsyncClient

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

Inheritance

builtins.object > JobServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
JobServiceTransportThe transport used by the client instance.

Methods

batch_create_jobs

batch_create_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchCreateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[Sequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Begins executing a batch create jobs operation.

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.BatchCreateJobsRequest, dict]

The request object. Request to create a batch of jobs.

parent `str`

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". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

jobs :class:`Sequence[google.cloud.talent_v4.types.Job]`

Required. The jobs to be created. A maximum of 200 jobs can be created in a batch. This corresponds to the jobs field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be BatchCreateJobsResponse The result of JobService.BatchCreateJobs. It's used to replace `google.longrunning.Operation.response][google.longrunning.Operation.response]` in case of success.

batch_delete_jobs

batch_delete_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchDeleteJobsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Begins executing a batch delete jobs operation.

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.BatchDeleteJobsRequest, dict]

The request object. Request to delete a batch of jobs.

parent `str`

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. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

names :class:`Sequence[str]`

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. This corresponds to the names field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be BatchDeleteJobsResponse The result of JobService.BatchDeleteJobs. It's used to replace `google.longrunning.Operation.response][google.longrunning.Operation.response]` in case of success.

batch_update_jobs

batch_update_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchUpdateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[Sequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Begins executing a batch update jobs operation.

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.BatchUpdateJobsRequest, dict]

The request object. Request to update a batch of jobs.

parent `str`

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". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

jobs :class:`Sequence[google.cloud.talent_v4.types.Job]`

Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch. This corresponds to the jobs field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be BatchUpdateJobsResponse The result of JobService.BatchUpdateJobs. It's used to replace `google.longrunning.Operation.response][google.longrunning.Operation.response]` in case of success.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

company_path

company_path(project: str, tenant: str, company: str)

Returns a fully-qualified company string.

Parameters
NameDescription
project str
tenant str
company str

create_job

create_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.CreateJobRequest, dict]] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.talent_v4.types.job.Job] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.CreateJobRequest, dict]

The request object. Create job request.

parent `str`

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". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

job Job

Required. The Job to be created. This corresponds to the job field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

delete_job

delete_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.DeleteJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.DeleteJobRequest, dict]

The request object. Delete job request.

name `str`

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". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

get_job

get_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.GetJobRequest, dict]

The request object. Get job request.

name `str`

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". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

job_path

job_path(project: str, tenant: str, job: str)

Returns a fully-qualified job string.

Parameters
NameDescription
project str
tenant str
job str

list_jobs

list_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists jobs by filter.

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.ListJobsRequest, dict]

The request object. List jobs request.

parent `str`

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". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter `str`

Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - companyName - requisitionId - status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. At least one of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown. Sample Query: - companyName = "projects/foo/tenants/bar/companies/baz" - companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" - companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED" - requisitionId = "req-1" - requisitionId = "req-1" AND status = "EXPIRED" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.services.job_service.pagers.ListJobsAsyncPagerList jobs response. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_company_path

parse_company_path(path: str)

Parses a company path into its component segments.

Parameter
NameDescription
path str

parse_job_path

parse_job_path(path: str)

Parses a job path into its component segments.

Parameter
NameDescription
path str

parse_tenant_path

parse_tenant_path(path: str)

Parses a tenant path into its component segments.

Parameter
NameDescription
path str

search_jobs

search_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches for jobs using the provided xref_SearchJobsRequest.

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

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.SearchJobsRequest, dict]

The request object. The Request body of the SearchJobs call.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.types.SearchJobsResponseResponse for SearchJob method.

search_jobs_for_alert

search_jobs_for_alert(request: Optional[Union[google.cloud.talent_v4.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches for jobs using the provided xref_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 xref_visibility of jobs present in the database, and only returns jobs the caller has permission to search against.

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.SearchJobsRequest, dict]

The request object. The Request body of the SearchJobs call.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.types.SearchJobsResponseResponse for SearchJob method.

tenant_path

tenant_path(project: str, tenant: str)

Returns a fully-qualified tenant string.

Parameters
NameDescription
project str
tenant str

update_job

update_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.UpdateJobRequest, dict]] = None, *, job: Optional[google.cloud.talent_v4.types.job.Job] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.talent_v4.types.UpdateJobRequest, dict]

The request object. Update job request.

job Job

Required. The Job to be updated. This corresponds to the job field on the request instance; if request is provided, this should not be set.

update_mask `google.protobuf.field_mask_pb2.FieldMask`

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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.talent_v4.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.