Class JobServiceAsyncClient (2.12.0)

JobServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.talent_v4beta1.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>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
JobServiceTransportThe transport used by the client instance.

Methods

JobServiceAsyncClient

JobServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.talent_v4beta1.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>)

Instantiates the job service client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, .JobServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

batch_create_jobs

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

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_v4beta1

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

    # 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 = (await operation).result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

jobs :class:MutableSequence[google.cloud.talent_v4beta1.types.Job]

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

retry google.api_core.retry_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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.BatchDeleteJobsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    filter: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a list of xref_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_v4beta1

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

    # Initialize request argument(s)
    request = talent_v4beta1.BatchDeleteJobsRequest(
        parent="parent_value",
        filter="filter_value",
    )

    # Make the request
    await client.batch_delete_jobs(request=request)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.types.BatchDeleteJobsRequest, dict]]

The request object. Batch delete jobs request.

parent str

Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: - companyName (Required) - requisitionId (Required) Sample Query: companyName = "projects/foo/companies/bar" AND requisitionId = "req-1" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry_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.

batch_update_jobs

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

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_v4beta1

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

    # 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 = (await operation).result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

jobs :class:MutableSequence[google.cloud.talent_v4beta1.types.Job]

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

retry google.api_core.retry_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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

company_path

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

Returns a fully-qualified company string.

create_job

create_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.CreateJobRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    job: typing.Optional[google.cloud.talent_v4beta1.types.job.Job] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.talent_v4beta1.types.job.Job

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_v4beta1

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

    # 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 = await client.create_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

job 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
TypeDescription
google.cloud.talent_v4beta1.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

delete_job

delete_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.DeleteJobRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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_v4beta1

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

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

    # Make the request
    await client.delete_job(request=request)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry_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.

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

from_service_account_info

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

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

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

from_service_account_json

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
JobServiceAsyncClientThe constructed client.

get_job

get_job(
    request: typing.Optional[
        typing.Union[google.cloud.talent_v4beta1.types.job_service.GetJobRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.talent_v4beta1.types.job.Job

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_v4beta1

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

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry_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
TypeDescription
google.cloud.talent_v4beta1.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.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 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.

Parameter
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_operation

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

Gets the latest state of a long-running operation.

Parameters
NameDescription
request .operations_pb2.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
TypeDescription
.operations_pb2.OperationAn Operation object.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.talent_v4beta1.services.job_service.transports.base.JobServiceTransport
    ]
)

Returns an appropriate transport class.

Parameter
NameDescription
label typing.Optional[str]

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

job_path

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

Returns a fully-qualified job string.

list_jobs

list_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.ListJobsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    filter: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.talent_v4beta1.services.job_service.pagers.ListJobsAsyncPager

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_v4beta1

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

    # 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
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - companyName - 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
TypeDescription
google.cloud.talent_v4beta1.services.job_service.pagers.ListJobsAsyncPagerList jobs response. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_company_path

parse_company_path(path: str) -> typing.Dict[str, str]

Parses a company path into its component segments.

parse_job_path

parse_job_path(path: str) -> typing.Dict[str, str]

Parses a job path into its component segments.

search_jobs

search_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.talent_v4beta1.services.job_service.pagers.SearchJobsAsyncPager

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.

# 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_v4beta1

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

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

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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
TypeDescription
google.cloud.talent_v4beta1.services.job_service.pagers.SearchJobsAsyncPagerResponse for SearchJob method. Iterating over this object will yield results and resolve additional pages automatically.

search_jobs_for_alert

search_jobs_for_alert(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.SearchJobsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.talent_v4beta1.services.job_service.pagers.SearchJobsForAlertAsyncPager
)

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.

# 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_v4beta1

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

    # 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
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.talent_v4beta1.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
TypeDescription
google.cloud.talent_v4beta1.services.job_service.pagers.SearchJobsForAlertAsyncPagerResponse for SearchJob method. Iterating over this object will yield results and resolve additional pages automatically.

update_job

update_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.talent_v4beta1.types.job_service.UpdateJobRequest, dict
        ]
    ] = None,
    *,
    job: typing.Optional[google.cloud.talent_v4beta1.types.job.Job] = None,
    retry: typing.Union[
        google.api_core.retry_async.AsyncRetry,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.talent_v4beta1.types.job.Job

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_v4beta1

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

    # 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 = await client.update_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[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 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
TypeDescription
google.cloud.talent_v4beta1.types.JobA Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.