JobServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.talent_v4beta1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = 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.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
JobServiceTransport | The transport used by the client instance. |
Methods
JobServiceAsyncClient
JobServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.talent_v4beta1.services.job_service.transports.base.JobServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates 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,
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
batch_create_jobs
batch_create_jobs(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.BatchCreateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[Sequence[google.cloud.talent_v4beta1.types.job.Job]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Begins executing a batch create jobs operation.
from google.cloud import talent_v4beta1
def sample_batch_create_jobs():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
jobs = talent_v4beta1.Job()
jobs.company = "company_value"
jobs.requisition_id = "requisition_id_value"
jobs.title = "title_value"
jobs.description = "description_value"
request = talent_v4beta1.BatchCreateJobsRequest(
parent="parent_value",
jobs=jobs,
)
# Make the request
operation = client.batch_create_jobs(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.BatchCreateJobsRequest, dict]
The request object. Request to create a batch of jobs. |
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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the |
jobs |
:class:
Required. The jobs to be created. This corresponds to the |
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 |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be 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[Union[google.cloud.talent_v4beta1.types.job_service.BatchDeleteJobsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a list of xref_Jobs by filter.
from google.cloud import talent_v4beta1
def sample_batch_delete_jobs():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.BatchDeleteJobsRequest(
parent="parent_value",
filter="filter_value",
)
# Make the request
client.batch_delete_jobs(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.BatchDeleteJobsRequest, dict]
The request object. Batch delete jobs request. |
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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the |
filter |
Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: - |
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[Union[google.cloud.talent_v4beta1.types.job_service.BatchUpdateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[Sequence[google.cloud.talent_v4beta1.types.job.Job]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Begins executing a batch update jobs operation.
from google.cloud import talent_v4beta1
def sample_batch_update_jobs():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
jobs = talent_v4beta1.Job()
jobs.company = "company_value"
jobs.requisition_id = "requisition_id_value"
jobs.title = "title_value"
jobs.description = "description_value"
request = talent_v4beta1.BatchUpdateJobsRequest(
parent="parent_value",
jobs=jobs,
)
# Make the request
operation = client.batch_update_jobs(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.BatchUpdateJobsRequest, dict]
The request object. Request to update a batch of jobs. |
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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the |
jobs |
:class:
Required. The jobs to be updated. This corresponds to the |
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 |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be 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. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
company_path
company_path(project: str, tenant: str, company: str)
Returns a fully-qualified company string.
create_job
create_job(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.CreateJobRequest, dict]] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.talent_v4beta1.types.job.Job] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import talent_v4beta1
def sample_create_job():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
job = talent_v4beta1.Job()
job.company = "company_value"
job.requisition_id = "requisition_id_value"
job.title = "title_value"
job.description = "description_value"
request = talent_v4beta1.CreateJobRequest(
parent="parent_value",
job=job,
)
# Make the request
response = client.create_job(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.CreateJobRequest, dict]
The request object. Create job request. |
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/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo". This corresponds to the |
job |
Job
Required. The Job to be created. This corresponds to the |
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 |
google.cloud.talent_v4beta1.types.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[Union[google.cloud.talent_v4beta1.types.job_service.DeleteJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import talent_v4beta1
def sample_delete_job():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.DeleteJobRequest(
name="name_value",
)
# Make the request
client.delete_job(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.DeleteJobRequest, dict]
The request object. Delete job request. |
name |
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 |
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 |
JobServiceAsyncClient | The 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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
JobServiceAsyncClient | 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 |
JobServiceAsyncClient | The constructed client. |
get_job
get_job(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import talent_v4beta1
def sample_get_job():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.GetJobRequest(
name="name_value",
)
# Make the request
response = client.get_job(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.GetJobRequest, dict]
The request object. Get job request. |
name |
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 |
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 |
google.cloud.talent_v4beta1.types.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_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
job_path
job_path(project: str, tenant: str, job: str)
Returns a fully-qualified job string.
list_jobs
list_jobs(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists jobs by filter.
from google.cloud import talent_v4beta1
def sample_list_jobs():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.ListJobsRequest(
parent="parent_value",
filter="filter_value",
)
# Make the request
page_result = client.list_jobs(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.ListJobsRequest, dict]
The request object. List jobs request. |
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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the |
filter |
Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - |
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 |
google.cloud.talent_v4beta1.services.job_service.pagers.ListJobsAsyncPager | List 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.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_company_path
parse_company_path(path: str)
Parses a company path into its component segments.
parse_job_path
parse_job_path(path: str)
Parses a job path into its component segments.
search_jobs
search_jobs(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import talent_v4beta1
def sample_search_jobs():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.SearchJobsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_jobs(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.SearchJobsRequest, dict]
The request object. The Request body of the |
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 |
google.cloud.talent_v4beta1.services.job_service.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[Union[google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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), 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.
from google.cloud import talent_v4beta1
def sample_search_jobs_for_alert():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.SearchJobsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_jobs_for_alert(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.SearchJobsRequest, dict]
The request object. The Request body of the |
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 |
google.cloud.talent_v4beta1.services.job_service.pagers.SearchJobsForAlertAsyncPager | Response for SearchJob method. Iterating over this object will yield results and resolve additional pages automatically. |
update_job
update_job(request: Optional[Union[google.cloud.talent_v4beta1.types.job_service.UpdateJobRequest, dict]] = None, *, job: Optional[google.cloud.talent_v4beta1.types.job.Job] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import talent_v4beta1
def sample_update_job():
# Create a client
client = talent_v4beta1.JobServiceClient()
# Initialize request argument(s)
job = talent_v4beta1.Job()
job.company = "company_value"
job.requisition_id = "requisition_id_value"
job.title = "title_value"
job.description = "description_value"
request = talent_v4beta1.UpdateJobRequest(
job=job,
)
# Make the request
response = client.update_job(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.UpdateJobRequest, dict]
The request object. Update job request. |
job |
Job
Required. The Job to be updated. This corresponds to the |
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 |
google.cloud.talent_v4beta1.types.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. |