Documentation

Google_Service_JobService_Resource_Jobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $jobsService = new Google_Service_JobService(...); $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_JobService_JobsEmpty
Deletes a list of Job postings by filter. (jobs.batchDelete)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_JobService_Job
Creates a new job.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_JobService_JobsEmpty
Deletes the specified job.
deleteByFilter()  : Google_Service_JobService_JobsEmpty
Deprecated. Use BatchDeleteJobs instead.
get()  : Google_Service_JobService_Job
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. (jobs.get)
histogram()  : Google_Service_JobService_GetHistogramResponse
Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram.
listJobs()  : Google_Service_JobService_ListJobsResponse
Lists jobs by filter. (jobs.listJobs)
patch()  : Google_Service_JobService_Job
Updates specified job.
search()  : Google_Service_JobService_SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest.
searchForAlert()  : Google_Service_JobService_SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest.
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 —

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 —

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.

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

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

Parameters
$name : string

Required.

The resource name of the job to be deleted, such as "jobs/11111111".

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

Optional parameters.

Tags
opt_param

bool disableFastProcess Deprecated. This field is not working anymore.

Optional.

If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.

Return values
Google_Service_JobService_JobsEmpty —

deleteByFilter()

Deprecated. Use BatchDeleteJobs instead.

public deleteByFilter(Google_Service_JobService_DeleteJobsByFilterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_JobService_JobsEmpty

Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned. (jobs.deleteByFilter)

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

Optional parameters.

Return values
Google_Service_JobService_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_JobService_Job
Parameters
$name : string

Required.

The resource name of the job to retrieve, such as "jobs/11111111".

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

Optional parameters.

Return values
Google_Service_JobService_Job —

histogram()

Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram.

public histogram(Google_Service_JobService_GetHistogramRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_JobService_GetHistogramResponse

Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets.

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

For example, use this call to generate the number of jobs in the U.S. by state. (jobs.histogram)

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

Optional parameters.

Return values
Google_Service_JobService_GetHistogramResponse —

listJobs()

Lists jobs by filter. (jobs.listJobs)

public listJobs([array<string|int, mixed> $optParams = array() ]) : Google_Service_JobService_ListJobsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1"
opt_param

string pageToken Optional.

The starting point of a query result.

opt_param

int pageSize Optional.

The maximum number of jobs to be returned per page of results.

If ids_only is set to true, 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

bool idsOnly Optional.

If set to true, only Job.name, Job.requisition_id and Job.language_code will be returned.

A typical use case is to synchronize job repositories.

Defaults to false.

Return values
Google_Service_JobService_ListJobsResponse —

patch()

Updates specified job.

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

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

Parameters
$name : string

Required during job update.

Resource name assigned to a job by the API, for example, "/jobs/foo". 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_JobService_UpdateJobRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_JobService_Job —

search()

Searches for jobs using the provided SearchJobsRequest.

public search(Google_Service_JobService_SearchJobsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_JobService_SearchJobsResponse

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)

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

Optional parameters.

Return values
Google_Service_JobService_SearchJobsResponse —

searchForAlert()

Searches for jobs using the provided SearchJobsRequest.

public searchForAlert(Google_Service_JobService_SearchJobsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_JobService_SearchJobsResponse

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)

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

Optional parameters.

Return values
Google_Service_JobService_SearchJobsResponse —

convertToArrayAndStripNulls()

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

Search results