Generate BigQuery Job ID on client side with optional prefix

composer.json

@@ -114,4 +114,4 @@
             "entry": "ServiceBuilder.php"
         }
     }
-}
+}

src/BigQuery/BigQueryClient.php

@@ -20,7 +20,6 @@
 use Google\Cloud\BigQuery\Connection\ConnectionInterface;
 use Google\Cloud\BigQuery\Connection\Rest;
 use Google\Cloud\BigQuery\Job;
-use Google\Cloud\Core\ArrayTrait;
 use Google\Cloud\Core\ClientTrait;
 use Google\Cloud\Core\ExponentialBackoff;
 use Google\Cloud\Core\Int64;
@@ -43,7 +42,6 @@
  */
 class BigQueryClient
 {
-    use ArrayTrait;
     use ClientTrait;
     use JobConfigurationTrait;
 
@@ -254,6 +252,8 @@ public function runQuery($query, array $options = [])
      *           If not provided default settings will be used, with the exception
      *           of `configuration.query.useLegacySql`, which defaults to `false`
      *           in this client.
+     *     @type string $jobIdPrefix If given, the returned job ID will be of
+     *           format `{$jobIdPrefix-}{jobId}`. **Defaults to** `null`.
      * }
      * @return Job
      */

src/BigQuery/JobConfigurationTrait.php

@@ -17,11 +17,16 @@
 
 namespace Google\Cloud\BigQuery;
 
+use Google\Cloud\Core\ArrayTrait;
+use Ramsey\Uuid\Uuid;
+
 /**
  * A trait used to build out configuration for jobs.
  */
 trait JobConfigurationTrait
 {
+    use ArrayTrait;
+
     /**
      * Builds a configuration for a job.
      *
@@ -33,6 +38,8 @@ trait JobConfigurationTrait
      */
     public function buildJobConfig($name, $projectId, array $config, array $userDefinedOptions)
     {
+        $jobIdPrefix = $this->pluck('jobIdPrefix', $userDefinedOptions, false);
+
         if (isset($userDefinedOptions['jobConfig'])) {
             $config = $userDefinedOptions['jobConfig'] + $config;
         }
@@ -41,9 +48,31 @@ public function buildJobConfig($name, $projectId, array $config, array $userDefi
 
         return [
             'projectId' => $projectId,
+            'jobReference' => [
+                'projectId' => $projectId,
+                'jobId' => $this->generateJobId($jobIdPrefix)
+            ],
             'configuration' => [
                 $name => $config
             ]
         ] + $userDefinedOptions;
     }
+
+    /**
+     * Generate a Job ID with an optional user-defined prefix.
+     *
+     * @param string $jobIdPrefix [optional] If given, the returned job ID will
+     *        be of format `{$jobIdPrefix-}{jobId}`. **Defaults to** `null`.
+     * @return string
+     */
+    protected function generateJobId($jobIdPrefix = null)
+    {
+        $jobId = '';
+
+        if ($jobIdPrefix) {
+            $jobId = $jobIdPrefix . '-';
+        }
+
+        return $jobId . Uuid::uuid4();
+    }
 }

src/BigQuery/Table.php

@@ -18,7 +18,6 @@
 namespace Google\Cloud\BigQuery;
 
 use Google\Cloud\BigQuery\Connection\ConnectionInterface;
-use Google\Cloud\Core\ArrayTrait;
 use Google\Cloud\Core\ConcurrencyControlTrait;
 use Google\Cloud\Core\Exception\NotFoundException;
 use Google\Cloud\Core\Iterator\ItemIterator;
@@ -33,7 +32,6 @@
  */
 class Table
 {
-    use ArrayTrait;
     use ConcurrencyControlTrait;
     use JobConfigurationTrait;
 
@@ -239,6 +237,8 @@ function (array $row) use ($schema) {
      *     @type array $jobConfig Configuration settings for a copy job are
      *           outlined in the [API Docs for `configuration.copy`](https://goo.gl/m8dro9).
      *           If not provided default settings will be used.
+     *     @type string $jobIdPrefix If given, the returned job ID will be of
+     *           format `{$jobIdPrefix-}{jobId}`. **Defaults to** `null`.
      * }
      * @return Job
      */
@@ -287,6 +287,8 @@ public function copy(Table $destination, array $options = [])
      *     @type array $jobConfig Configuration settings for an extract job are
      *           outlined in the [API Docs for `configuration.extract`](https://goo.gl/SQ9XAE).
      *           If not provided default settings will be used.
+     *     @type string $jobIdPrefix If given, the returned job ID will be of
+     *           format `{$jobIdPrefix-}{jobId}`. **Defaults to** `null`.
      * }
      * @return Job
      */
@@ -334,6 +336,8 @@ public function export($destination, array $options = [])
      *     @type array $jobConfig Configuration settings for a load job are
      *           outlined in the [API Docs for `configuration.load`](https://goo.gl/j6jyHv).
      *           If not provided default settings will be used.
+     *     @type string $jobIdPrefix If given, the returned job ID will be of
+     *           format `{$jobIdPrefix-}{jobId}`. **Defaults to** `null`.
      * }
      * @return Job
      */

src/BigQuery/composer.json

@@ -4,7 +4,8 @@
     "license": "Apache-2.0",
     "minimum-stability": "stable",
     "require": {
-        "google/cloud-core": "^1.0"
+        "google/cloud-core": "^1.0",
+        "ramsey/uuid": "~3"
     },
     "suggest": {
         "google/cloud-storage": "Makes it easier to load data from Cloud Storage into BigQuery"

tests/snippets/BigQuery/BigQueryClientTest.php

@@ -36,6 +36,8 @@
  */
 class BigQueryClientTest extends SnippetTestCase
 {
+    const JOBID = 'myJobId';
+
     private $connection;
     private $client;
     private $result = [
@@ -63,7 +65,7 @@ class BigQueryClientTest extends SnippetTestCase
     public function setUp()
     {
         $this->connection = $this->prophesize(ConnectionInterface::class);
-        $this->client = \Google\Cloud\Dev\stub(BigQueryClient::class);
+        $this->client = \Google\Cloud\Dev\stub(BigQueryTestClient::class);
         $this->client->___setProperty('connection', $this->connection->reveal());
     }
 
@@ -106,6 +108,7 @@ public function testRunQueryWithNamedParameters()
         $this->connection
             ->insertJob([
                 'projectId' => 'my-awesome-project',
+                'jobReference' => ['projectId' => 'my-awesome-project', 'jobId' => self::JOBID],
                 'configuration' => [
                     'query' => [
                         'parameterMode' => 'named',
@@ -159,6 +162,7 @@ public function testRunQueryWithPositionalParameters()
         $this->connection
             ->insertJob([
                 'projectId' => 'my-awesome-project',
+                'jobReference' => ['projectId' => 'my-awesome-project', 'jobId' => self::JOBID],
                 'configuration' => [
                     'query' => [
                         'parameterMode' => 'positional',
@@ -351,3 +355,11 @@ public function testTimestamp()
         $this->assertInstanceOf(Timestamp::class, $res->returnVal());
     }
 }
+
+class BigQueryTestClient extends BigQueryClient
+{
+    protected function generateJobId($jobIdPrefix = null)
+    {
+        return $jobIdPrefix ? $jobIdPrefix . '-' . BigQueryClientTest::JOBID : BigQueryClientTest::JOBID;
+    }
+}