As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

JobService

class google.cloud.talent_v4.services.job_service.JobServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport, typing.Callable[[...], google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]

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

Instantiates the job service async client.

Parameters

  • 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 (Optional[Union[str,JobServiceTransport,Callable[..., JobServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the JobServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

async batch_create_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchCreateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[MutableSequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Begins executing a batch create jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_batch_create_jobs():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    jobs = talent_v4.Job()
    jobs.company = "company_value"
    jobs.requisition_id = "requisition_id_value"
    jobs.title = "title_value"
    jobs.description = "description_value"

    request = talent_v4.BatchCreateJobsRequest(
        parent="parent_value",
        jobs=jobs,
    )

    # Make the request
    operation = client.batch_create_jobs(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[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 (MutableSequence[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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchCreateJobsResponse The result of

[JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation_async.AsyncOperation

async batch_delete_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchDeleteJobsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Begins executing a batch delete jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_batch_delete_jobs():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.BatchDeleteJobsRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.batch_delete_jobs(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[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 (MutableSequence[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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchDeleteJobsResponse The result of

[JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation_async.AsyncOperation

async batch_update_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchUpdateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[MutableSequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Begins executing a batch update jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_batch_update_jobs():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    jobs = talent_v4.Job()
    jobs.company = "company_value"
    jobs.requisition_id = "requisition_id_value"
    jobs.title = "title_value"
    jobs.description = "description_value"

    request = talent_v4.BatchUpdateJobsRequest(
        parent="parent_value",
        jobs=jobs,
    )

    # Make the request
    operation = client.batch_update_jobs(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[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 (MutableSequence[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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchUpdateJobsResponse The result of

[JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation_async.AsyncOperation

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

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

Returns a fully-qualified company string.

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

Creates a new job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_create_job():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    job = talent_v4.Job()
    job.company = "company_value"
    job.requisition_id = "requisition_id_value"
    job.title = "title_value"
    job.description = "description_value"

    request = talent_v4.CreateJobRequest(
        parent="parent_value",
        job=job,
    )

    # Make the request
    response = await client.create_job(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[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 (google.cloud.talent_v4.types.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_async.AsyncRetry) – 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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

async delete_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.DeleteJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes the specified job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_delete_job():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.DeleteJobRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_job(request=request)
Parameters

  • request (Optional[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_async.AsyncRetry) – 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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • 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

The constructed client.

Return type

JobServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • 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

The constructed client.

Return type

JobServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • 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

The constructed client.

Return type

JobServiceAsyncClient

async get_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_get_job():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.GetJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_job(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[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_async.AsyncRetry) – 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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]

Gets the latest state of a long-running operation.

Parameters

  • request (GetOperationRequest) – The request object. Request message for GetOperation method.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

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

Returns a fully-qualified job string.

async list_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.services.job_service.pagers.ListJobsAsyncPager[source]

Lists jobs by filter.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_list_jobs():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.ListJobsRequest(
        parent="parent_value",
        filter="filter_value",
    )

    # Make the request
    page_result = client.list_jobs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters

  • request (Optional[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_async.AsyncRetry) – 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

List jobs response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.talent_v4.services.job_service.pagers.ListJobsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_company_path(path: str) → Dict[str, str]

Parses a company path into its component segments.

static parse_job_path(path: str) → Dict[str, str]

Parses a job path into its component segments.

static parse_tenant_path(path: str) → Dict[str, str]

Parses a tenant path into its component segments.

async search_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job_service.SearchJobsResponse[source]

Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].

This call constrains the [visibility][google.cloud.talent.v4.Job.visibility] of jobs present in the database, and only returns jobs that the caller has permission to search against.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_search_jobs():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.SearchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.search_jobs(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.talent_v4.types.SearchJobsRequest, dict]]) – The request object. The Request body of the SearchJobs call.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Response for SearchJob method.

Return type

google.cloud.talent_v4.types.SearchJobsResponse

async search_jobs_for_alert(request: Optional[Union[google.cloud.talent_v4.types.job_service.SearchJobsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job_service.SearchJobsResponse[source]

Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.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][google.cloud.talent.v4.Job.visibility] of jobs present in the database, and only returns jobs the caller has permission to search against.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_search_jobs_for_alert():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    request = talent_v4.SearchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.search_jobs_for_alert(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.talent_v4.types.SearchJobsRequest, dict]]) – The request object. The Request body of the SearchJobs call.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Response for SearchJob method.

Return type

google.cloud.talent_v4.types.SearchJobsResponse

static tenant_path(project: str, tenant: str) → str

Returns a fully-qualified tenant string.

property transport: google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

JobServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

Updates specified job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

async def sample_update_job():
    # Create a client
    client = talent_v4.JobServiceAsyncClient()

    # Initialize request argument(s)
    job = talent_v4.Job()
    job.company = "company_value"
    job.requisition_id = "requisition_id_value"
    job.title = "title_value"
    job.description = "description_value"

    request = talent_v4.UpdateJobRequest(
        job=job,
    )

    # Make the request
    response = await client.update_job(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.talent_v4.types.UpdateJobRequest, dict]]) – The request object. Update job request.

  • job (google.cloud.talent_v4.types.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][google.cloud.talent.v4.UpdateJobRequest.update_mask] is provided, only the specified fields in [job][google.cloud.talent.v4.UpdateJobRequest.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][google.cloud.talent.v4.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_async.AsyncRetry) – 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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

class google.cloud.talent_v4.services.job_service.JobServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport, typing.Callable[[...], google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the job service client.

Parameters

  • 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 (Optional[Union[str,JobServiceTransport,Callable[..., JobServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the JobServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

batch_create_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchCreateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[MutableSequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Begins executing a batch create jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_batch_create_jobs():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    jobs = talent_v4.Job()
    jobs.company = "company_value"
    jobs.requisition_id = "requisition_id_value"
    jobs.title = "title_value"
    jobs.description = "description_value"

    request = talent_v4.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

  • 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 (MutableSequence[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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchCreateJobsResponse The result of

[JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation.Operation

batch_delete_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchDeleteJobsRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Begins executing a batch delete jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_batch_delete_jobs():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.BatchDeleteJobsRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.batch_delete_jobs(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • 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 (MutableSequence[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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchDeleteJobsResponse The result of

[JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation.Operation

batch_update_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.BatchUpdateJobsRequest, dict]] = None, *, parent: Optional[str] = None, jobs: Optional[MutableSequence[google.cloud.talent_v4.types.job.Job]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Begins executing a batch update jobs operation.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_batch_update_jobs():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    jobs = talent_v4.Job()
    jobs.company = "company_value"
    jobs.requisition_id = "requisition_id_value"
    jobs.title = "title_value"
    jobs.description = "description_value"

    request = talent_v4.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

  • 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 (MutableSequence[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

An object representing a long-running operation.

The result type for the operation will be google.cloud.talent_v4.types.BatchUpdateJobsResponse The result of

[JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

Return type

google.api_core.operation.Operation

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

static company_path(project: str, tenant: str, company: str) → str[source]

Returns a fully-qualified company string.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

Creates a new job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_create_job():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    job = talent_v4.Job()
    job.company = "company_value"
    job.requisition_id = "requisition_id_value"
    job.title = "title_value"
    job.description = "description_value"

    request = talent_v4.CreateJobRequest(
        parent="parent_value",
        job=job,
    )

    # Make the request
    response = client.create_job(request=request)

    # Handle the response
    print(response)
Parameters

  • 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 (google.cloud.talent_v4.types.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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

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

Deletes the specified job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_delete_job():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.DeleteJobRequest(
        name="name_value",
    )

    # Make the request
    client.delete_job(request=request)
Parameters

  • 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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • 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

The constructed client.

Return type

JobServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • 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

The constructed client.

Return type

JobServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • 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

The constructed client.

Return type

JobServiceClient

get_job(request: Optional[Union[google.cloud.talent_v4.types.job_service.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_get_job():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.GetJobRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_job(request=request)

    # Handle the response
    print(response)
Parameters

  • 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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Deprecated. 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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]

Gets the latest state of a long-running operation.

Parameters

  • request (GetOperationRequest) – The request object. Request message for GetOperation method.

  • 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

An Operation object.

Return type

Operation

static job_path(project: str, tenant: str, job: str) → str[source]

Returns a fully-qualified job string.

list_jobs(request: Optional[Union[google.cloud.talent_v4.types.job_service.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.services.job_service.pagers.ListJobsPager[source]

Lists jobs by filter.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_list_jobs():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.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

  • 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

List jobs response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.talent_v4.services.job_service.pagers.ListJobsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_company_path(path: str) → Dict[str, str][source]

Parses a company path into its component segments.

static parse_job_path(path: str) → Dict[str, str][source]

Parses a job path into its component segments.

static parse_tenant_path(path: str) → Dict[str, str][source]

Parses a tenant path into its component segments.

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

Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].

This call constrains the [visibility][google.cloud.talent.v4.Job.visibility] of jobs present in the database, and only returns jobs that the caller has permission to search against.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_search_jobs():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.SearchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.search_jobs(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response for SearchJob method.

Return type

google.cloud.talent_v4.types.SearchJobsResponse

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

Searches for jobs using the provided [SearchJobsRequest][google.cloud.talent.v4.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][google.cloud.talent.v4.Job.visibility] of jobs present in the database, and only returns jobs the caller has permission to search against.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_search_jobs_for_alert():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    request = talent_v4.SearchJobsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.search_jobs_for_alert(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response for SearchJob method.

Return type

google.cloud.talent_v4.types.SearchJobsResponse

static tenant_path(project: str, tenant: str) → str[source]

Returns a fully-qualified tenant string.

property transport: google.cloud.talent_v4.services.job_service.transports.base.JobServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

JobServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.talent_v4.types.job.Job[source]

Updates specified job.

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import talent_v4

def sample_update_job():
    # Create a client
    client = talent_v4.JobServiceClient()

    # Initialize request argument(s)
    job = talent_v4.Job()
    job.company = "company_value"
    job.requisition_id = "requisition_id_value"
    job.title = "title_value"
    job.description = "description_value"

    request = talent_v4.UpdateJobRequest(
        job=job,
    )

    # Make the request
    response = client.update_job(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.talent_v4.types.UpdateJobRequest, dict]) – The request object. Update job request.

  • job (google.cloud.talent_v4.types.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][google.cloud.talent.v4.UpdateJobRequest.update_mask] is provided, only the specified fields in [job][google.cloud.talent.v4.UpdateJobRequest.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][google.cloud.talent.v4.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

A Job resource represents a job posting (also referred to as a “job listing”

or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4.Company], which is the hiring entity responsible for the job.

Return type

google.cloud.talent_v4.types.Job

class google.cloud.talent_v4.services.job_service.pagers.ListJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.talent_v4.types.job_service.ListJobsResponse]], request: google.cloud.talent_v4.types.job_service.ListJobsRequest, response: google.cloud.talent_v4.types.job_service.ListJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_jobs requests.

This class thinly wraps an initial google.cloud.talent_v4.types.ListJobsResponse object, and provides an __aiter__ method to iterate through its jobs field.

If there are more pages, the __aiter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual google.cloud.talent_v4.types.ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.talent_v4.services.job_service.pagers.ListJobsPager(method: Callable[[...], google.cloud.talent_v4.types.job_service.ListJobsResponse], request: google.cloud.talent_v4.types.job_service.ListJobsRequest, response: google.cloud.talent_v4.types.job_service.ListJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_jobs requests.

This class thinly wraps an initial google.cloud.talent_v4.types.ListJobsResponse object, and provides an __iter__ method to iterate through its jobs field.

If there are more pages, the __iter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual google.cloud.talent_v4.types.ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters