Google_Service_Bigquery_Jobs_Resource Class Reference

The "jobs" collection of methods. More...

Inheritance diagram for Google_Service_Bigquery_Jobs_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	cancel ($projectId, $jobId, $optParams=array())
	Requests that a job be cancelled.
	get ($projectId, $jobId, $optParams=array())
	Returns information about a specific job.
	getQueryResults ($projectId, $jobId, $optParams=array())
	Retrieves the results of a query job.
	insert ($projectId, Google_Service_Bigquery_Job $postBody, $optParams=array())
	Starts a new asynchronous job.
	listJobs ($projectId, $optParams=array())
	Lists all jobs that you started in the specified project.
	query ($projectId, Google_Service_Bigquery_QueryRequest $postBody, $optParams=array())
	Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "jobs" collection of methods.

Typical usage is: $bigqueryService = new Google_Service_Bigquery(...); $jobs = $bigqueryService->jobs;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

cancel()

Google_Service_Bigquery_Jobs_Resource::cancel	(		$projectId,
			$jobId,
			$optParams = array() )

Requests that a job be cancelled.

This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. (jobs.cancel)

Parameters

string	$projectId	Project ID of the job to cancel
string	$jobId	Job ID of the job to cancel
array	$optParams	Optional parameters.

Return values

Google_Service_Bigquery_JobCancelResponse

get()

Google_Service_Bigquery_Jobs_Resource::get	(		$projectId,
			$jobId,
			$optParams = array() )

Returns information about a specific job.

Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. (jobs.get)

Parameters

string	$projectId	Project ID of the requested job
string	$jobId	Job ID of the requested job
array	$optParams	Optional parameters.

Return values

Google_Service_Bigquery_Job

getQueryResults()

Google_Service_Bigquery_Jobs_Resource::getQueryResults	(		$projectId,
			$jobId,
			$optParams = array() )

Retrieves the results of a query job.

(jobs.getQueryResults)

Parameters

string	$projectId	Project ID of the query job
string	$jobId	Job ID of the query job
array	$optParams	Optional parameters.

@opt_param string timeoutMs How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false @opt_param string maxResults Maximum number of results to read @opt_param string pageToken Page token, returned by a previous call, to request the next page of results @opt_param string startIndex Zero-based index of the starting row

Return values

Google_Service_Bigquery_GetQueryResultsResponse

insert()

Google_Service_Bigquery_Jobs_Resource::insert	(		$projectId,
		Google_Service_Bigquery_Job	$postBody,
			$optParams = array() )

Starts a new asynchronous job.

Requires the Can View project role. (jobs.insert)

Parameters

string	$projectId	Project ID of the project that will be billed for the job
Google_Job	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Bigquery_Job

listJobs()

Google_Service_Bigquery_Jobs_Resource::listJobs	(		$projectId,
			$optParams = array() )

Lists all jobs that you started in the specified project.

Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. (jobs.listJobs)

Parameters

string	$projectId	Project ID of the jobs to list
array	$optParams	Optional parameters.

@opt_param string projection Restrict information returned to a set of selected fields @opt_param string stateFilter Filter for job state @opt_param bool allUsers Whether to display jobs owned by all users in the project. Default false @opt_param string maxResults Maximum number of results to return @opt_param string pageToken Page token, returned by a previous call, to request the next page of results

Return values

Google_Service_Bigquery_JobList

query()

Google_Service_Bigquery_Jobs_Resource::query	(		$projectId,
		Google_Service_Bigquery_QueryRequest	$postBody,
			$optParams = array() )

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

(jobs.query)

Parameters

string	$projectId	Project ID of the project billed for the query
Google_QueryRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Bigquery_QueryResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Bigquery.php