Google_JobsServiceResource

The "jobs" collection of methods.

Defined (2)

The class is defined in the following location(s).

/src/contrib/Google_BigqueryService.php  
  1. class Google_JobsServiceResource extends Google_ServiceResource { 
  2.  
  3.   /** 
  4.    * Retrieves the specified job by ID. (jobs.get) 
  5.    * 
  6.    * @param string $projectId Project ID of the requested job 
  7.    * @param string $jobId Job ID of the requested job 
  8.    * @param array $optParams Optional parameters. 
  9.    * @return Google_Job 
  10.    */ 
  11.   public function get($projectId, $jobId, $optParams = array()) { 
  12.     $params = array('projectId' => $projectId, 'jobId' => $jobId); 
  13.     $params = array_merge($params, $optParams); 
  14.     $data = $this->__call('get', array($params)); 
  15.     if ($this->useObjects()) { 
  16.       return new Google_Job($data); 
  17.     } else { 
  18.       return $data; 
  19.     } 
  20.   } 
  21.   /** 
  22.    * Retrieves the results of a query job. (jobs.getQueryResults) 
  23.    * 
  24.    * @param string $projectId Project ID of the query job 
  25.    * @param string $jobId Job ID of the query job 
  26.    * @param array $optParams Optional parameters. 
  27.    * 
  28.    * @opt_param string maxResults Maximum number of results to read 
  29.    * @opt_param string pageToken Page token, returned by a previous call, to request the next page of results 
  30.    * @opt_param string startIndex Zero-based index of the starting row 
  31.    * @opt_param string timeoutMs How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error 
  32.    * @return Google_GetQueryResultsResponse 
  33.    */ 
  34.   public function getQueryResults($projectId, $jobId, $optParams = array()) { 
  35.     $params = array('projectId' => $projectId, 'jobId' => $jobId); 
  36.     $params = array_merge($params, $optParams); 
  37.     $data = $this->__call('getQueryResults', array($params)); 
  38.     if ($this->useObjects()) { 
  39.       return new Google_GetQueryResultsResponse($data); 
  40.     } else { 
  41.       return $data; 
  42.     } 
  43.   } 
  44.   /** 
  45.    * Starts a new asynchronous job. (jobs.insert) 
  46.    * 
  47.    * @param string $projectId Project ID of the project that will be billed for the job 
  48.    * @param Google_Job $postBody 
  49.    * @param array $optParams Optional parameters. 
  50.    * @return Google_Job 
  51.    */ 
  52.   public function insert($projectId, Google_Job $postBody, $optParams = array()) { 
  53.     $params = array('projectId' => $projectId, 'postBody' => $postBody); 
  54.     $params = array_merge($params, $optParams); 
  55.     $data = $this->__call('insert', array($params)); 
  56.     if ($this->useObjects()) { 
  57.       return new Google_Job($data); 
  58.     } else { 
  59.       return $data; 
  60.     } 
  61.   } 
  62.   /** 
  63.    * Lists all the Jobs in the specified project that were started by the user. (jobs.list) 
  64.    * 
  65.    * @param string $projectId Project ID of the jobs to list 
  66.    * @param array $optParams Optional parameters. 
  67.    * 
  68.    * @opt_param bool allUsers Whether to display jobs owned by all users in the project. Default false 
  69.    * @opt_param string maxResults Maximum number of results to return 
  70.    * @opt_param string pageToken Page token, returned by a previous call, to request the next page of results 
  71.    * @opt_param string projection Restrict information returned to a set of selected fields 
  72.    * @opt_param string stateFilter Filter for job state 
  73.    * @return Google_JobList 
  74.    */ 
  75.   public function listJobs($projectId, $optParams = array()) { 
  76.     $params = array('projectId' => $projectId); 
  77.     $params = array_merge($params, $optParams); 
  78.     $data = $this->__call('list', array($params)); 
  79.     if ($this->useObjects()) { 
  80.       return new Google_JobList($data); 
  81.     } else { 
  82.       return $data; 
  83.     } 
  84.   } 
  85.   /** 
  86.    * Runs a BigQuery SQL query synchronously and returns query results if the query completes within a 
  87.    * specified timeout. (jobs.query) 
  88.    * 
  89.    * @param string $projectId Project ID of the project billed for the query 
  90.    * @param Google_QueryRequest $postBody 
  91.    * @param array $optParams Optional parameters. 
  92.    * @return Google_QueryResponse 
  93.    */ 
  94.   public function query($projectId, Google_QueryRequest $postBody, $optParams = array()) { 
  95.     $params = array('projectId' => $projectId, 'postBody' => $postBody); 
  96.     $params = array_merge($params, $optParams); 
  97.     $data = $this->__call('query', array($params)); 
  98.     if ($this->useObjects()) { 
  99.       return new Google_QueryResponse($data); 
  100.     } else { 
  101.       return $data; 
  102.     } 
  103.   } 
  104. } 
/src/contrib/Google_CoordinateService.php  
  1. class Google_JobsServiceResource extends Google_ServiceResource { 
  2.  
  3.   /** 
  4.    * Retrieves a job, including all the changes made to the job. (jobs.get) 
  5.    * 
  6.    * @param string $teamId Team ID 
  7.    * @param string $jobId Job number 
  8.    * @param array $optParams Optional parameters. 
  9.    * @return Google_Job 
  10.    */ 
  11.   public function get($teamId, $jobId, $optParams = array()) { 
  12.     $params = array('teamId' => $teamId, 'jobId' => $jobId); 
  13.     $params = array_merge($params, $optParams); 
  14.     $data = $this->__call('get', array($params)); 
  15.     if ($this->useObjects()) { 
  16.       return new Google_Job($data); 
  17.     } else { 
  18.       return $data; 
  19.     } 
  20.   } 
  21.   /** 
  22.    * Inserts a new job. Only the state field of the job should be set. (jobs.insert) 
  23.    * 
  24.    * @param string $teamId Team ID 
  25.    * @param string $address Job address as newline (Unix) separated string 
  26.    * @param double $lat The latitude coordinate of this job's location. 
  27.    * @param double $lng The longitude coordinate of this job's location. 
  28.    * @param string $title Job title 
  29.    * @param Google_Job $postBody 
  30.    * @param array $optParams Optional parameters. 
  31.    * 
  32.    * @opt_param string assignee Assignee email address, or empty string to unassign. 
  33.    * @opt_param string customField Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' 
  34.    * @opt_param string customerName Customer name 
  35.    * @opt_param string customerPhoneNumber Customer phone number 
  36.    * @opt_param string note Job note as newline (Unix) separated string 
  37.    * @return Google_Job 
  38.    */ 
  39.   public function insert($teamId, $address, $lat, $lng, $title, Google_Job $postBody, $optParams = array()) { 
  40.     $params = array('teamId' => $teamId, 'address' => $address, 'lat' => $lat, 'lng' => $lng, 'title' => $title, 'postBody' => $postBody); 
  41.     $params = array_merge($params, $optParams); 
  42.     $data = $this->__call('insert', array($params)); 
  43.     if ($this->useObjects()) { 
  44.       return new Google_Job($data); 
  45.     } else { 
  46.       return $data; 
  47.     } 
  48.   } 
  49.   /** 
  50.    * Retrieves jobs created or modified since the given timestamp. (jobs.list) 
  51.    * 
  52.    * @param string $teamId Team ID 
  53.    * @param array $optParams Optional parameters. 
  54.    * 
  55.    * @opt_param string maxResults Maximum number of results to return in one page. 
  56.    * @opt_param string minModifiedTimestampMs Minimum time a job was modified in milliseconds since epoch. 
  57.    * @opt_param string pageToken Continuation token 
  58.    * @return Google_JobListResponse 
  59.    */ 
  60.   public function listJobs($teamId, $optParams = array()) { 
  61.     $params = array('teamId' => $teamId); 
  62.     $params = array_merge($params, $optParams); 
  63.     $data = $this->__call('list', array($params)); 
  64.     if ($this->useObjects()) { 
  65.       return new Google_JobListResponse($data); 
  66.     } else { 
  67.       return $data; 
  68.     } 
  69.   } 
  70.   /** 
  71.    * Updates a job. Fields that are set in the job state will be updated. This method supports patch 
  72.    * semantics. (jobs.patch) 
  73.    * 
  74.    * @param string $teamId Team ID 
  75.    * @param string $jobId Job number 
  76.    * @param Google_Job $postBody 
  77.    * @param array $optParams Optional parameters. 
  78.    * 
  79.    * @opt_param string address Job address as newline (Unix) separated string 
  80.    * @opt_param string assignee Assignee email address, or empty string to unassign. 
  81.    * @opt_param string customField Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' 
  82.    * @opt_param string customerName Customer name 
  83.    * @opt_param string customerPhoneNumber Customer phone number 
  84.    * @opt_param double lat The latitude coordinate of this job's location. 
  85.    * @opt_param double lng The longitude coordinate of this job's location. 
  86.    * @opt_param string note Job note as newline (Unix) separated string 
  87.    * @opt_param string progress Job progress 
  88.    * @opt_param string title Job title 
  89.    * @return Google_Job 
  90.    */ 
  91.   public function patch($teamId, $jobId, Google_Job $postBody, $optParams = array()) { 
  92.     $params = array('teamId' => $teamId, 'jobId' => $jobId, 'postBody' => $postBody); 
  93.     $params = array_merge($params, $optParams); 
  94.     $data = $this->__call('patch', array($params)); 
  95.     if ($this->useObjects()) { 
  96.       return new Google_Job($data); 
  97.     } else { 
  98.       return $data; 
  99.     } 
  100.   } 
  101.   /** 
  102.    * Updates a job. Fields that are set in the job state will be updated. (jobs.update) 
  103.    * 
  104.    * @param string $teamId Team ID 
  105.    * @param string $jobId Job number 
  106.    * @param Google_Job $postBody 
  107.    * @param array $optParams Optional parameters. 
  108.    * 
  109.    * @opt_param string address Job address as newline (Unix) separated string 
  110.    * @opt_param string assignee Assignee email address, or empty string to unassign. 
  111.    * @opt_param string customField Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' 
  112.    * @opt_param string customerName Customer name 
  113.    * @opt_param string customerPhoneNumber Customer phone number 
  114.    * @opt_param double lat The latitude coordinate of this job's location. 
  115.    * @opt_param double lng The longitude coordinate of this job's location. 
  116.    * @opt_param string note Job note as newline (Unix) separated string 
  117.    * @opt_param string progress Job progress 
  118.    * @opt_param string title Job title 
  119.    * @return Google_Job 
  120.    */ 
  121.   public function update($teamId, $jobId, Google_Job $postBody, $optParams = array()) { 
  122.     $params = array('teamId' => $teamId, 'jobId' => $jobId, 'postBody' => $postBody); 
  123.     $params = array_merge($params, $optParams); 
  124.     $data = $this->__call('update', array($params)); 
  125.     if ($this->useObjects()) { 
  126.       return new Google_Job($data); 
  127.     } else { 
  128.       return $data; 
  129.     } 
  130.   } 
  131. }