Class JobServiceAsyncClient (1.0.0)

JobServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.talent_v4beta1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-talent/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Inheritance

builtins.object > JobServiceAsyncClient

Methods

JobServiceAsyncClient

JobServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.talent_v4beta1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-talent/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the job service client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, `.JobServiceTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

batch_create_jobs

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

Begins executing a batch create jobs operation.

Parameters

Name	Description
request	`.job_service.BatchCreateJobsRequest` 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
jobs	:class:`Sequence[`.job.Job`]` Required. The jobs to be created. 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

Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be ```.job_service.JobOperationResult```: The result of JobService.BatchCreateJobs or JobService.BatchUpdateJobs APIs. 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[google.cloud.talent_v4beta1.types.job_service.BatchDeleteJobsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a list of xref_Jobs by filter.

Parameters

Name	Description
request	`.job_service.BatchDeleteJobsRequest` The request object. Batch delete 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". 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 deleted. Supported operator: =, AND The fields eligible for filtering are: - `companyName` (Required) - `requisitionId` (Required) Sample Query: companyName = "projects/foo/companies/bar" AND requisitionId = "req-1". 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.

batch_update_jobs

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

Begins executing a batch update jobs operation.

Parameters

Name	Description
request	`.job_service.BatchUpdateJobsRequest` 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
jobs	:class:`Sequence[`.job.Job`]` Required. The jobs to be updated. 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

Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be ```.job_service.JobOperationResult```: The result of JobService.BatchCreateJobs or JobService.BatchUpdateJobs APIs. It's used to replace `google.longrunning.Operation.response][google.longrunning.Operation.response]` in case of success.

create_job

create_job(request: Optional[google.cloud.talent_v4beta1.types.job_service.CreateJobRequest] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.talent_v4beta1.types.job.Job] = None, retry: google.api_core.retry.Retry = <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

Name	Description
request	`.job_service.CreateJobRequest` 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/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
job	`.gct_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

Type	Description
`.gct_job.Job`	A 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[google.cloud.talent_v4beta1.types.job_service.DeleteJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <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

Name	Description
request	`.job_service.DeleteJobRequest` 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". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar". 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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
{@api.name}	The 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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
{@api.name}	The constructed client.

get_job

get_job(request: Optional[google.cloud.talent_v4beta1.types.job_service.GetJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <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

Name	Description
request	`.job_service.GetJobRequest` 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". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar". 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

Type	Description
`.job.Job`	A 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()

Return an appropriate transport class.

job_path

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

Return a fully-qualified job string.

list_jobs

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

Lists jobs by filter.

Parameters

Name	Description
request	`.job_service.ListJobsRequest` 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". 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` (Required) - `requisitionId` - `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. 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". 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

Type	Description
`.pagers.ListJobsAsyncPager`	List jobs response. Iterating over this object will yield results and resolve additional pages automatically.

parse_job_path

parse_job_path(path: str)

Parse a job path into its component segments.

search_jobs

search_jobs(request: Optional[google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest] = None, *, retry: google.api_core.retry.Retry = <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

Name	Description
request	`.job_service.SearchJobsRequest` 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

Type	Description
`.pagers.SearchJobsAsyncPager`	Response for SearchJob method. Iterating over this object will yield results and resolve additional pages automatically.

search_jobs_for_alert

search_jobs_for_alert(request: Optional[google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest] = None, *, retry: google.api_core.retry.Retry = <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), and has different algorithmic adjustments that are targeted to 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

Name	Description
request	`.job_service.SearchJobsRequest` 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

Type	Description
`.pagers.SearchJobsForAlertAsyncPager`	Response for SearchJob method. Iterating over this object will yield results and resolve additional pages automatically.

update_job

update_job(request: Optional[google.cloud.talent_v4beta1.types.job_service.UpdateJobRequest] = None, *, job: Optional[google.cloud.talent_v4beta1.types.job.Job] = None, retry: google.api_core.retry.Retry = <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

Name	Description
request	`.job_service.UpdateJobRequest` The request object. Update job request.
job	`.gct_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.
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

Type	Description
`.gct_job.Job`	A 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.