Documentation

Google_Service_CloudTalentSolution_Resource_ProjectsJobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $jobsService = new Google_Service_CloudTalentSolution(...); $jobs = $jobsService->jobs;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchDelete()  : Google_Service_CloudTalentSolution_JobsEmpty
Deletes a list of Jobs by filter. (jobs.batchDelete)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudTalentSolution_Job
Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. (jobs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudTalentSolution_JobsEmpty
Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. (jobs.delete)
get()  : Google_Service_CloudTalentSolution_Job
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. (jobs.get)
listProjectsJobs()  : Google_Service_CloudTalentSolution_ListJobsResponse
Lists jobs by filter. (jobs.listProjectsJobs)
patch()  : Google_Service_CloudTalentSolution_Job
Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. (jobs.patch)
search()  : Google_Service_CloudTalentSolution_SearchJobsResponse
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. (jobs.search)
searchForAlert()  : Google_Service_CloudTalentSolution_SearchJobsResponse
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), and has different algorithmic adjustments that are targeted to 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. (jobs.searchForAlert)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

batchDelete()

Deletes a list of Jobs by filter. (jobs.batchDelete)

public batchDelete(string $parent, Google_Service_CloudTalentSolution_BatchDeleteJobsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_JobsEmpty
Parameters
$parent : string

Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".

$postBody : Google_Service_CloudTalentSolution_BatchDeleteJobsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_JobsEmpty

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. (jobs.create)

public create(string $parent, Google_Service_CloudTalentSolution_CreateJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_Job
Parameters
$parent : string

Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".

$postBody : Google_Service_CloudTalentSolution_CreateJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_Job

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. (jobs.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_JobsEmpty
Parameters
$name : string

Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api- test-project/jobs/1234".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_JobsEmpty

get()

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

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_Job
Parameters
$name : string

Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api- test-project/jobs/1234".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_Job

listProjectsJobs()

Lists jobs by filter. (jobs.listProjectsJobs)

public listProjectsJobs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_ListJobsResponse
Parameters
$parent : string

Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string jobView Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

opt_param

string filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are:

  • companyName (Required) * requisitionId (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"
opt_param

int pageSize Optional. The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.

opt_param

string pageToken Optional. The starting point of a query result.

Return values
Google_Service_CloudTalentSolution_ListJobsResponse

patch()

Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. (jobs.patch)

public patch(string $name, Google_Service_CloudTalentSolution_UpdateJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_Job
Parameters
$name : string

Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test- project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

$postBody : Google_Service_CloudTalentSolution_UpdateJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_Job

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. (jobs.search)

public search(string $parent, Google_Service_CloudTalentSolution_SearchJobsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_SearchJobsResponse
Parameters
$parent : string

Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api- test-project".

$postBody : Google_Service_CloudTalentSolution_SearchJobsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_SearchJobsResponse

searchForAlert()

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), and has different algorithmic adjustments that are targeted to 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. (jobs.searchForAlert)

public searchForAlert(string $parent, Google_Service_CloudTalentSolution_SearchJobsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTalentSolution_SearchJobsResponse
Parameters
$parent : string

Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api- test-project".

$postBody : Google_Service_CloudTalentSolution_SearchJobsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudTalentSolution_SearchJobsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results