Google Cloud Talent Solution V4 Client - Class JobServiceClient (1.2.2)

Version 1.2.2

• 2.0.2 (latest)
• 2.0.1
• 1.3.5
• 1.2.2
• 1.1.1
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class JobServiceClient.

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Talent\V4\JobServiceClient for the stable implementation

Namespace

Google \ Cloud \ Talent \ V4 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchCreateJobs

Begins executing a batch create jobs operation.

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::batchCreateJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchCreateJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

batchDeleteJobs

Begins executing a batch delete jobs operation.

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::batchDeleteJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchDeleteJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

batchUpdateJobs

Begins executing a batch update jobs operation.

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::batchUpdateJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchUpdateJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createJob

Creates a new job.

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::createJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\CreateJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Talent\V4\Job

deleteJob

Deletes the specified job.

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::deleteJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\DeleteJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getJob

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::getJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\GetJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Talent\V4\Job

listJobs

Lists jobs by filter.

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::listJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\ListJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

searchJobs

Searches for jobs using the provided SearchJobsRequest.

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::searchJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\SearchJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Talent\V4\SearchJobsResponse

searchJobsForAlert

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::searchJobsForAlertAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\SearchJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Talent\V4\SearchJobsResponse

updateJob

Updates specified job.

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

The async variant is Google\Cloud\Talent\V4\Client\JobServiceClient::updateJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Talent\V4\UpdateJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Talent\V4\Job

batchCreateJobsAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchCreateJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchDeleteJobsAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchDeleteJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateJobsAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\BatchUpdateJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createJobAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\CreateJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteJobAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\DeleteJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getJobAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\GetJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listJobsAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\ListJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

searchJobsAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\SearchJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

searchJobsForAlertAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\SearchJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateJobAsync

Parameters
Name	Description
request	Google\Cloud\Talent\V4\UpdateJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::companyName

Formats a string containing the fully-qualified path to represent a company resource.

Parameters
Name	Description
project	string
tenant	string
company	string

Returns
Type	Description
string	The formatted company resource.

static::jobName

Formats a string containing the fully-qualified path to represent a job resource.

Parameters
Name	Description
project	string
tenant	string
job	string

Returns
Type	Description
string	The formatted job resource.

static::tenantName

Formats a string containing the fully-qualified path to represent a tenant resource.

Parameters
Name	Description
project	string
tenant	string

Returns
Type	Description
string	The formatted tenant resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• company: projects/{project}/tenants/{tenant}/companies/{company}
• job: projects/{project}/tenants/{tenant}/jobs/{job}
• tenant: projects/{project}/tenants/{tenant}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.