DLP: Add autoPopulateTimespan option for creating job triggers. (GoogleCloudPlatform#633)

Author: micheldavid

dlp/dlp.php

@@ -276,6 +276,7 @@
     ->addArgument('trigger-id', InputArgument::OPTIONAL, 'The name of the trigger to be created', '')
     ->addArgument('display-name', InputArgument::OPTIONAL, 'The human-readable name to give the trigger', '')
     ->addArgument('description', InputArgument::OPTIONAL, 'A description for the trigger to be created', '')
+    ->addArgument('auto-populate-timespan', InputArgument::OPTIONAL, 'Limit scan to new content only')
     ->addArgument(
         'max-findings',
         InputArgument::OPTIONAL,
@@ -291,7 +292,8 @@
             $input->getArgument('display-name'),
             $input->getArgument('description'),
             (int) $input->getArgument('frequency'),
-            (int) $input->getArgument('max-findings')
+            (int) $input->getArgument('max-findings'),
+            (bool) $input->getArgument('auto-populate-timespan')
         );
     });
 

dlp/src/create_trigger.php

@@ -28,6 +28,7 @@
 use Google\Cloud\Dlp\V2\CloudStorageOptions;
 use Google\Cloud\Dlp\V2\CloudStorageOptions_FileSet;
 use Google\Cloud\Dlp\V2\StorageConfig;
+use Google\Cloud\Dlp\V2\StorageConfig_TimespanConfig;
 use Google\Cloud\Dlp\V2\InfoType;
 use Google\Cloud\Dlp\V2\Likelihood;
 use Google\Cloud\Dlp\V2\InspectConfig_FindingLimits;
@@ -43,6 +44,7 @@
  * @param string $description (Optional) A description for the trigger to be created
  * @param int $scanPeriod (Optional) How often to wait between scans, in days (minimum = 1 day)
  * @param int $maxFindings (Optional) The maximum number of findings to report per request (0 = server maximum)
+ * @param bool $autoPopulateTimespan (Optional) Automatically limit scan to new content only
  */
 
 function create_trigger(
@@ -52,7 +54,8 @@ function create_trigger(
     $displayName = '',
     $description = '',
     $scanPeriod = 1,
-    $maxFindings = 0
+    $maxFindings = 0,
+    $autoPopulateTimespan = false
 ) {
     // Instantiate a client.
     $dlp = new DlpServiceClient();
@@ -95,8 +98,13 @@ function create_trigger(
     $storageOptions = (new CloudStorageOptions())
         ->setFileSet($fileSet);
 
+    // Auto-populate start and end times in order to scan new objects only.
+    $timespanConfig = (new StorageConfig_TimespanConfig())
+        ->setEnableAutoPopulationOfTimespanConfig($autoPopulateTimespan);
+
     $storageConfig = (new StorageConfig())
-        ->setCloudStorageOptions($storageOptions);
+        ->setCloudStorageOptions($storageOptions)
+        ->setTimespanConfig($timespanConfig);
 
     // Construct the jobConfig object
     $jobConfig = (new InspectJobConfig())

dlp/src/list_inspect_templates.php

@@ -45,11 +45,14 @@ function list_inspect_templates($callingProjectId)
         printf('  Description: %s' . PHP_EOL, $template->getDescription());
 
         $inspectConfig = $template->getInspectConfig();
-        printf('  Minimum likelihood: %s' . PHP_EOL, $inspectConfig->getMinLikelihood());
-        printf('  Include quotes: %s' . PHP_EOL, $inspectConfig->getIncludeQuote());
-
-        $limits = $inspectConfig->getLimits();
-        printf('  Max findings per request: %s' . PHP_EOL, $limits->getMaxFindingsPerRequest());
+        if ($inspectConfig === null) {
+            print('  No inspect config.' . PHP_EOL);
+        } else {
+            printf('  Minimum likelihood: %s' . PHP_EOL, $inspectConfig->getMinLikelihood());
+            printf('  Include quotes: %s' . PHP_EOL, $inspectConfig->getIncludeQuote());
+            $limits = $inspectConfig->getLimits();
+            printf('  Max findings per request: %s' . PHP_EOL, $limits->getMaxFindingsPerRequest());
+        }
     }
 }
 // [END dlp_list_inspect_templates]

dlp/src/list_triggers.php

@@ -44,6 +44,9 @@ function list_triggers($callingProjectId)
         printf('  Description: %s' . PHP_EOL, $trigger->getDescription());
         printf('  Status: %s' . PHP_EOL, $trigger->getStatus());
         printf('  Error count: %s' . PHP_EOL, count($trigger->getErrors()));
+        printf('  Auto-populates timespan config: %s' . PHP_EOL, ($trigger->
+            getInspectJob()->getStorageConfig()->getTimespanConfig()->
+            getEnableAutoPopulationOfTimespanConfig() ? 'yes' : 'no'));
     }
 }
 # [END dlp_list_triggers]

dlp/test/data/.gitignore

@@ -0,0 +1,3 @@
+# Test outputs
+*.output.*
+

dlp/test/dlpTest.php

@@ -236,14 +236,16 @@ public function testTriggers()
             'display-name' => $displayName,
             'description' => $description,
             'trigger-id' => $triggerId,
-            'frequency' => 1
+            'frequency' => 1,
+            'auto-populate-timespan' => true,
         ]);
         $this->assertContains('Successfully created trigger ' . $triggerId, $output);
 
         $output = $this->runCommand('list-triggers', []);
         $this->assertContains('Trigger ' . $fullTriggerId, $output);
         $this->assertContains('Display Name: ' . $displayName, $output);
         $this->assertContains('Description: ' . $description, $output);
+        $this->assertContains('Auto-populates timespan config: yes', $output);
 
         $output = $this->runCommand('delete-trigger', [
             'trigger-id' => $fullTriggerId