* $bigqueryService = new Google\Service\Bigquery(...); * $jobs = $bigqueryService->jobs; * */ class Jobs extends \Google\Service\Resource { /** * 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) * * @param string $projectId [Required] Project ID of the job to cancel * @param string $jobId [Required] Job ID of the job to cancel * @param array $optParams Optional parameters. * * @opt_param string location The geographic location of the job. Required * except for US and EU. See details at * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. * @return JobCancelResponse */ public function cancel($projectId, $jobId, $optParams = []) { $params = ['projectId' => $projectId, 'jobId' => $jobId]; $params = array_merge($params, $optParams); return $this->call('cancel', [$params], JobCancelResponse::class); } /** * Requests the deletion of the metadata of a job. This call returns when the * job's metadata is deleted. (jobs.delete) * * @param string $projectId Required. Project ID of the job for which metadata * is to be deleted. * @param string $jobId Required. Job ID of the job for which metadata is to be * deleted. If this is a parent job which has child jobs, the metadata from all * child jobs will be deleted as well. Direct deletion of the metadata of child * jobs is not allowed. * @param array $optParams Optional parameters. * * @opt_param string location The geographic location of the job. Required. See * details at: * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ public function delete($projectId, $jobId, $optParams = []) { $params = ['projectId' => $projectId, 'jobId' => $jobId]; $params = array_merge($params, $optParams); return $this->call('delete', [$params]); } /** * 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) * * @param string $projectId [Required] Project ID of the requested job * @param string $jobId [Required] Job ID of the requested job * @param array $optParams Optional parameters. * * @opt_param string location The geographic location of the job. Required * except for US and EU. See details at * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. * @return Job */ public function get($projectId, $jobId, $optParams = []) { $params = ['projectId' => $projectId, 'jobId' => $jobId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Job::class); } /** * Retrieves the results of a query job. (jobs.getQueryResults) * * @param string $projectId [Required] Project ID of the query job * @param string $jobId [Required] Job ID of the query job * @param array $optParams Optional parameters. * * @opt_param string location The geographic location where the job should run. * Required except for US and EU. See details at * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. * @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 * @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 * @return GetQueryResultsResponse */ public function getQueryResults($projectId, $jobId, $optParams = []) { $params = ['projectId' => $projectId, 'jobId' => $jobId]; $params = array_merge($params, $optParams); return $this->call('getQueryResults', [$params], GetQueryResultsResponse::class); } /** * Starts a new asynchronous job. Requires the Can View project role. * (jobs.insert) * * @param string $projectId Project ID of the project that will be billed for * the job * @param Job $postBody * @param array $optParams Optional parameters. * @return Job */ public function insert($projectId, Job $postBody, $optParams = []) { $params = ['projectId' => $projectId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('insert', [$params], Job::class); } /** * 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) * * @param string $projectId Project ID of the jobs to list * @param array $optParams Optional parameters. * * @opt_param bool allUsers Whether to display jobs owned by all users in the * project. Default false * @opt_param string maxCreationTime Max value for job creation time, in * milliseconds since the POSIX epoch. If set, only jobs created before or at * this timestamp are returned * @opt_param string maxResults Maximum number of results to return * @opt_param string minCreationTime Min value for job creation time, in * milliseconds since the POSIX epoch. If set, only jobs created after or at * this timestamp are returned * @opt_param string pageToken Page token, returned by a previous call, to * request the next page of results * @opt_param string parentJobId If set, retrieves only jobs whose parent is * this job. Otherwise, retrieves only jobs which have no parent * @opt_param string projection Restrict information returned to a set of * selected fields * @opt_param string stateFilter Filter for job state * @return JobList */ public function listJobs($projectId, $optParams = []) { $params = ['projectId' => $projectId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], JobList::class); } /** * Runs a BigQuery SQL query synchronously and returns query results if the * query completes within a specified timeout. (jobs.query) * * @param string $projectId Project ID of the project billed for the query * @param QueryRequest $postBody * @param array $optParams Optional parameters. * @return QueryResponse */ public function query($projectId, QueryRequest $postBody, $optParams = []) { $params = ['projectId' => $projectId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('query', [$params], QueryResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(Jobs::class, 'Google_Service_Bigquery_Resource_Jobs');