From 502f7f4e6cf33a1577bb0de283de7ffdff05f6c1 Mon Sep 17 00:00:00 2001
From: Yash Sahu <54198301+yash30201@users.noreply.github.com>
Date: Thu, 6 Apr 2023 01:05:40 +0530
Subject: [PATCH 001/285] feat[BigqueryStorage]: Added quickstart sample
(#1781)
---
bigquerystorage/composer.json | 6 ++
bigquerystorage/phpunit.xml.dist | 34 ++++++++
bigquerystorage/quickstart.php | 106 ++++++++++++++++++++++++
bigquerystorage/test/quickstartTest.php | 76 +++++++++++++++++
4 files changed, 222 insertions(+)
create mode 100644 bigquerystorage/composer.json
create mode 100644 bigquerystorage/phpunit.xml.dist
create mode 100644 bigquerystorage/quickstart.php
create mode 100644 bigquerystorage/test/quickstartTest.php
diff --git a/bigquerystorage/composer.json b/bigquerystorage/composer.json
new file mode 100644
index 0000000000..69e75346b3
--- /dev/null
+++ b/bigquerystorage/composer.json
@@ -0,0 +1,6 @@
+{
+ "require": {
+ "google/cloud-bigquery-storage": "^1.2",
+ "rg/avro-php": "^3.0"
+ }
+}
diff --git a/bigquerystorage/phpunit.xml.dist b/bigquerystorage/phpunit.xml.dist
new file mode 100644
index 0000000000..c1b9afacdb
--- /dev/null
+++ b/bigquerystorage/phpunit.xml.dist
@@ -0,0 +1,34 @@
+
+
+
+
+
+ test
+
+
+
+
+
+
+
+ quickstart.php
+
+ ./vendor
+
+
+
+
diff --git a/bigquerystorage/quickstart.php b/bigquerystorage/quickstart.php
new file mode 100644
index 0000000000..1f72fd5606
--- /dev/null
+++ b/bigquerystorage/quickstart.php
@@ -0,0 +1,106 @@
+projectName('YOUR_PROJECT_ID');
+$snapshotMillis = 'YOUR_SNAPSHOT_MILLIS';
+
+// This example reads baby name data from the below public dataset.
+$table = $client->tableName(
+ 'bigquery-public-data',
+ 'usa_names',
+ 'usa_1910_current'
+);
+
+// This API can also deliver data serialized in Apache Arrow format.
+// This example leverages Apache Avro.
+$readSession = new ReadSession();
+$readSession->setTable($table)->setDataFormat(DataFormat::AVRO);
+
+// We limit the output columns to a subset of those allowed in the table,
+// and set a simple filter to only report names from the state of
+// Washington (WA).
+$readOptions = new TableReadOptions();
+$readOptions->setSelectedFields(['name', 'number', 'state']);
+$readOptions->setRowRestriction('state = "WA"');
+$readSession->setReadOptions($readOptions);
+
+// With snapshot millis if present
+if (!empty($snapshotMillis)) {
+ $timestamp = new Timestamp();
+ $timestamp->setSeconds($snapshotMillis / 1000);
+ $timestamp->setNanos((int) ($snapshotMillis % 1000) * 1000000);
+ $tableModifier = new TableModifiers();
+ $tableModifier->setSnapshotTime($timestamp);
+ $readSession->setTableModifiers($tableModifier);
+}
+
+try {
+ $session = $client->createReadSession(
+ $project,
+ $readSession,
+ [
+ // We'll use only a single stream for reading data from the table.
+ // However, if you wanted to fan out multiple readers you could do so
+ // by having a reader process each individual stream.
+ 'maxStreamCount' => 1
+ ]
+ );
+ $stream = $client->readRows($session->getStreams()[0]->getName());
+ // Do any local processing by iterating over the responses. The
+ // google-cloud-bigquery-storage client reconnects to the API after any
+ // transient network errors or timeouts.
+ $schema = '';
+ $names = [];
+ $states = [];
+ foreach ($stream->readAll() as $response) {
+ $data = $response->getAvroRows()->getSerializedBinaryRows();
+ if ($response->hasAvroSchema()) {
+ $schema = $response->getAvroSchema()->getSchema();
+ }
+ $avroSchema = AvroSchema::parse($schema);
+ $readIO = new AvroStringIO($data);
+ $datumReader = new AvroIODatumReader($avroSchema);
+
+ while (!$readIO->is_eof()) {
+ $record = $datumReader->read(new AvroIOBinaryDecoder($readIO));
+ $names[$record['name']] = '';
+ $states[$record['state']] = '';
+ }
+ }
+ $states = array_keys($states);
+ printf(
+ 'Got %d unique names in states: %s' . PHP_EOL,
+ count($names),
+ implode(', ', $states)
+ );
+} finally {
+ $client->close();
+}
+# [END bigquerystorage_quickstart]
diff --git a/bigquerystorage/test/quickstartTest.php b/bigquerystorage/test/quickstartTest.php
new file mode 100644
index 0000000000..47a4cf3675
--- /dev/null
+++ b/bigquerystorage/test/quickstartTest.php
@@ -0,0 +1,76 @@
+markTestSkipped('GOOGLE_PROJECT_ID must be set.');
+ }
+
+ $file = sys_get_temp_dir() . '/bigquerystorage_quickstart.php';
+ $contents = file_get_contents(__DIR__ . '/../quickstart.php');
+ // Five hundred milli seconds into the past
+ $snapshotTimeMillis = floor(microtime(true) * 1000) - 5000;
+
+ $contents = str_replace(
+ ['YOUR_PROJECT_ID', '__DIR__', 'YOUR_SNAPSHOT_MILLIS'],
+ [$projectId, sprintf('"%s/.."', __DIR__), $snapshotTimeMillis],
+ $contents
+ );
+ file_put_contents($file, $contents);
+
+ // Invoke quickstart.php and capture output
+ ob_start();
+ include $file;
+ $result = ob_get_clean();
+
+ // Assertion for without snapshot millis
+ $expected = sprintf('Got 6482 unique names in states: WA');
+ $this->assertStringContainsString($expected, $result);
+ }
+
+ public function testQuickstartWithoutSnapshotMillis()
+ {
+ if (!$projectId = getenv('GOOGLE_PROJECT_ID')) {
+ $this->markTestSkipped('GOOGLE_PROJECT_ID must be set.');
+ }
+
+ $file = sys_get_temp_dir() . '/bigquerystorage_quickstart.php';
+ $contents = file_get_contents(__DIR__ . '/../quickstart.php');
+ // Five hundred milli seconds into the past
+
+ $contents = str_replace(
+ ['YOUR_PROJECT_ID', '__DIR__', 'YOUR_SNAPSHOT_MILLIS'],
+ [$projectId, sprintf('"%s/.."', __DIR__), ''],
+ $contents
+ );
+ file_put_contents($file, $contents);
+
+ // Invoke quickstart.php and capture output
+ ob_start();
+ include $file;
+ $result = ob_get_clean();
+
+ // Assertion for with snapshot millis
+ $expected = sprintf('Got 6482 unique names in states: WA');
+ $this->assertStringContainsString($expected, $result);
+ }
+}
From e06a4fd2d1556a8a15a13fc3a7ff1f81384b63a8 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 19 Apr 2023 20:42:15 +0530
Subject: [PATCH 002/285] feat(dlp): inspect a string for sensitive data, using
exclusion dictionary (#1807)
---
.../inspect_string_with_exclusion_dict.php | 117 ++++++++++++++++++
dlp/test/dlpTest.php | 11 ++
2 files changed, 128 insertions(+)
create mode 100644 dlp/src/inspect_string_with_exclusion_dict.php
diff --git a/dlp/src/inspect_string_with_exclusion_dict.php b/dlp/src/inspect_string_with_exclusion_dict.php
new file mode 100644
index 0000000000..d66b9550d2
--- /dev/null
+++ b/dlp/src/inspect_string_with_exclusion_dict.php
@@ -0,0 +1,117 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $infotypes = [
+ (new InfoType())->setName('PHONE_NUMBER'),
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('CREDIT_CARD_NUMBER'),
+ ];
+
+ // Exclude matches from the specified excludedMatchList.
+ $excludedMatchList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords(['example@example.com']));
+ $matchingType = MatchingType::MATCHING_TYPE_FULL_MATCH;
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType($matchingType)
+ ->setDictionary($excludedMatchList);
+
+ // Construct a ruleset that applies the exclusion rule to the EMAIL_ADDRESSES infotype.
+ $emailAddress = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$emailAddress])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infotypes)
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_string_with_exclusion_dict]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 7b34de839a..62e1803f1d 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -258,4 +258,15 @@ public function testJobs()
);
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+
+ public function testInspectStringWithExclusionDict()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_with_exclusion_dict', [
+ self::$projectId,
+ 'Some email addresses: gary@example.com, example@example.com'
+ ]);
+
+ $this->assertStringContainsString('Quote: gary@example.com', $output);
+ $this->assertStringNotContainsString('Quote: example@example.com', $output);
+ }
}
From 1dab3cb3d759d0dcf60e1809c53b779ff98c19d7 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 19 Apr 2023 21:11:26 +0530
Subject: [PATCH 003/285] feat(dlp): inspect a string for sensitive data,
omitting overlapping matches on domain and email (#1805)
---
dlp/src/inspect_string_without_overlap.php | 126 +++++++++++++++++++++
dlp/test/dlpTest.php | 11 ++
2 files changed, 137 insertions(+)
create mode 100644 dlp/src/inspect_string_without_overlap.php
diff --git a/dlp/src/inspect_string_without_overlap.php b/dlp/src/inspect_string_without_overlap.php
new file mode 100644
index 0000000000..3733491531
--- /dev/null
+++ b/dlp/src/inspect_string_without_overlap.php
@@ -0,0 +1,126 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $domainName = (new InfoType())
+ ->setName('DOMAIN_NAME');
+ $emailAddress = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $infoTypes = [$domainName, $emailAddress];
+
+ // Define a custom info type to exclude email addresses
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($emailAddress)
+ ->setExclusionType(ExclusionType::EXCLUSION_TYPE_EXCLUDE);
+
+ // Exclude EMAIL_ADDRESS matches
+ $matchingType = MatchingType::MATCHING_TYPE_PARTIAL_MATCH;
+
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType($matchingType)
+ ->setExcludeInfoTypes((new ExcludeInfoTypes())
+ ->setInfoTypes([$customInfoType->getInfoType()])
+ );
+
+ // Construct a ruleset that applies the exclusion rule to the DOMAIN_NAME infotype.
+ // If a DOMAIN_NAME match is part of an EMAIL_ADDRESS match, the DOMAIN_NAME match will
+ // be excluded.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$domainName])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes)
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(
+ ' Likelihood: %s' . PHP_EOL,
+ Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_string_without_overlap]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 62e1803f1d..9b6f77cf2d 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,17 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectStringWithoutOverlap()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_without_overlap', [
+ self::$projectId,
+ 'example.com is a domain, james@example.org is an email.'
+ ]);
+
+ $this->assertStringContainsString('Info type: DOMAIN_NAME', $output);
+ $this->assertStringNotContainsString('Info type: EMAIL_ADDRESS', $output);
+ }
+
public function testInspectStringWithExclusionDict()
{
$output = $this->runFunctionSnippet('inspect_string_with_exclusion_dict', [
From 8fa91d0e42378e9c38f5494beba68c6682283618 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 19 Apr 2023 23:05:03 +0530
Subject: [PATCH 004/285] feat(dlp): de-identify sensitive data with a simple
word list (#1794)
---
dlp/src/deidentify_simple_word_list.php | 108 ++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 ++
2 files changed, 117 insertions(+)
create mode 100644 dlp/src/deidentify_simple_word_list.php
diff --git a/dlp/src/deidentify_simple_word_list.php b/dlp/src/deidentify_simple_word_list.php
new file mode 100644
index 0000000000..a18284af4a
--- /dev/null
+++ b/dlp/src/deidentify_simple_word_list.php
@@ -0,0 +1,108 @@
+setValue($string);
+
+ // Construct the word list to be detected
+ $wordList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords(['RM-GREEN', 'RM-YELLOW', 'RM-ORANGE']));
+
+ // The infoTypes of information to mask
+ $custoMRoomIdinfoType = (new InfoType())
+ ->setName('CUSTOM_ROOM_ID');
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($custoMRoomIdinfoType)
+ ->setDictionary($wordList);
+
+ // Create the configuration object
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType]);
+
+ // Create the information transform configuration objects
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceWithInfoTypeConfig(new ReplaceWithInfoTypeConfig());
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes([$custoMRoomIdinfoType]);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the deidentification configuration object
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content,
+ 'inspectConfig' => $inspectConfig
+ ]);
+
+ // Print the results
+ printf('Deidentified content: %s', $response->getItem()->getValue());
+}
+# [END dlp_deidentify_simple_word_list]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 9b6f77cf2d..b91ddb4f7c 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testDeidentifySimpleWordList()
+ {
+ $output = $this->runFunctionSnippet('deidentify_simple_word_list', [
+ self::$projectId,
+ 'Patient was seen in RM-YELLOW then transferred to rm green.'
+ ]);
+ $this->assertStringContainsString('[CUSTOM_ROOM_ID]', $output);
+ }
+
public function testInspectStringWithoutOverlap()
{
$output = $this->runFunctionSnippet('inspect_string_without_overlap', [
From baefcd5f359ff7ae2400dc5fb9724e349f8e299f Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 19 Apr 2023 23:21:34 +0530
Subject: [PATCH 005/285] feat(dlp): create an exception list for
de-identification (#1795)
---
dlp/src/deidentify_exception_list.php | 118 ++++++++++++++++++++++++++
dlp/test/dlpTest.php | 11 +++
2 files changed, 129 insertions(+)
create mode 100644 dlp/src/deidentify_exception_list.php
diff --git a/dlp/src/deidentify_exception_list.php b/dlp/src/deidentify_exception_list.php
new file mode 100644
index 0000000000..a81e229e4a
--- /dev/null
+++ b/dlp/src/deidentify_exception_list.php
@@ -0,0 +1,118 @@
+setValue($textToDeIdentify);
+
+ // Construct the custom word list to be detected.
+ $wordList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords(['jack@example.org', 'jill@example.org']));
+
+ // Specify the exclusion rule and build-in info type the inspection will look for.
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_FULL_MATCH)
+ ->setDictionary($wordList);
+
+ $emailAddress = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$emailAddress])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule)
+ ]);
+
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$emailAddress])
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Define type of deidentification as replacement.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceWithInfoTypeConfig(new ReplaceWithInfoTypeConfig());
+
+ // Associate de-identification type with info type.
+ $transformation = (new InfoTypeTransformation())
+ ->setInfoTypes([$emailAddress])
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ // Construct the configuration for the de-id request and list all desired transformations.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations(
+ (new InfoTypeTransformations())
+ ->setTransformations([$transformation])
+ );
+
+ // Send the request and receive response from the service
+ $parent = "projects/$callingProjectId/locations/global";
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print the results
+ printf('Text after replace with infotype config: %s', $response->getItem()->getValue());
+}
+# [END dlp_deidentify_exception_list]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index b91ddb4f7c..733a26c8df 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,17 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testDeIdentifyExceptionList()
+ {
+ $output = $this->runFunctionSnippet('deidentify_exception_list', [
+ self::$projectId,
+ 'jack@example.org accessed customer record of user5@example.com'
+ ]);
+ $this->assertStringContainsString('[EMAIL_ADDRESS]', $output);
+ $this->assertStringContainsString('jack@example.org', $output);
+ $this->assertStringNotContainsString('user5@example.com', $output);
+ }
+
public function testDeidentifySimpleWordList()
{
$output = $this->runFunctionSnippet('deidentify_simple_word_list', [
From 37698625777e0a0150fa2d8bd929cce7a3daeb31 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Fri, 21 Apr 2023 06:53:31 -0600
Subject: [PATCH 006/285] Update CODEOWNERS (#1814)
---
CODEOWNERS | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/CODEOWNERS b/CODEOWNERS
index 9fa6ae3f17..879d0daddc 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -29,9 +29,10 @@
# Functions samples owned by the Firebase team
/functions/firebase_analytics @schandel
+# DLP samples owned by DLP team
+/dlp/ @GoogleCloudPlatform/googleapis-dlp
-# Brent is taking ownership of these samples as they are not supported by the ML team
-/dlp/ @bshaffer
+# Brent is taking ownership of these samples as they are not supported by the ML team
/dialogflow/ @bshaffer
/language/ @bshaffer
/speech/ @bshaffer
From 4f00dc158099d6ea511d62e54e469255284c5e97 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Sun, 23 Apr 2023 04:03:24 +0530
Subject: [PATCH 007/285] feat(dlp): inspect data for phone numbers sample
(#1796)
---
dlp/src/inspect_phone_number.php | 88 ++++++++++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 ++++
2 files changed, 97 insertions(+)
create mode 100644 dlp/src/inspect_phone_number.php
diff --git a/dlp/src/inspect_phone_number.php b/dlp/src/inspect_phone_number.php
new file mode 100644
index 0000000000..6d062b2365
--- /dev/null
+++ b/dlp/src/inspect_phone_number.php
@@ -0,0 +1,88 @@
+setValue($textToInspect);
+
+ $inspectConfig = (new InspectConfig())
+ // The infoTypes of information to match
+ ->setInfoTypes([
+ (new InfoType())->setName('PHONE_NUMBER'),
+ ])
+ // Whether to include the matching string
+ ->setIncludeQuote(true)
+ ->setMinLikelihood(Likelihood::POSSIBLE);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_phone_number]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 733a26c8df..3634fb952f 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectPhoneNumber()
+ {
+ $output = $this->runFunctionSnippet('inspect_phone_number', [
+ self::$projectId,
+ 'My name is Gary and my phone number is (415) 555-0890'
+ ]);
+ $this->assertStringContainsString('Info type: PHONE_NUMBER', $output);
+ }
+
public function testDeIdentifyExceptionList()
{
$output = $this->runFunctionSnippet('deidentify_exception_list', [
From c8fc7fba4b33d2aa979177d16a4a112c88d565ae Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 24 Apr 2023 20:05:35 +0530
Subject: [PATCH 008/285] feat(dlp): inspect a string for sensitive data,
omitting custom matches (#1802)
---
.../inspect_string_custom_omit_overlap.php | 121 ++++++++++++++++++
dlp/test/dlpTest.php | 12 ++
2 files changed, 133 insertions(+)
create mode 100644 dlp/src/inspect_string_custom_omit_overlap.php
diff --git a/dlp/src/inspect_string_custom_omit_overlap.php b/dlp/src/inspect_string_custom_omit_overlap.php
new file mode 100644
index 0000000000..a68773f90c
--- /dev/null
+++ b/dlp/src/inspect_string_custom_omit_overlap.php
@@ -0,0 +1,121 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $vipDetector = (new InfoType())
+ ->setName('VIP_DETECTOR');
+ $pattern = 'Larry Page|Sergey Brin';
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($vipDetector)
+ ->setRegex((new Regex())
+ ->setPattern($pattern))
+ ->setExclusionType(ExclusionType::EXCLUSION_TYPE_EXCLUDE);
+
+ // Exclude matches that also match the custom infotype.
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_FULL_MATCH)
+ ->setExcludeInfoTypes((new ExcludeInfoTypes())
+ ->setInfoTypes([$customInfoType->getInfoType()])
+ );
+
+ // Construct a ruleset that applies the exclusion rule to the PERSON_NAME infotype.
+ $personName = (new InfoType())
+ ->setName('PERSON_NAME');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$personName])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$personName])
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_string_custom_omit_overlap]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 3634fb952f..009bcbc0de 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,18 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectStringCustomOmitOverlap()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_custom_omit_overlap', [
+ self::$projectId,
+ 'Name: Jane Doe. Name: Larry Page.'
+ ]);
+
+ $this->assertStringContainsString('Info type: PERSON_NAME', $output);
+ $this->assertStringContainsString('Jane Doe', $output);
+ $this->assertStringNotContainsString('Larry Page', $output);
+ }
+
public function testInspectPhoneNumber()
{
$output = $this->runFunctionSnippet('inspect_phone_number', [
From 47cbbec6402847068e241f3331bb7b8b5671edfb Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 24 Apr 2023 21:02:17 +0530
Subject: [PATCH 009/285] feat(dlp): inspect a string for sensitive data,
omitting overlapping matches on person and email (#1806)
---
dlp/src/inspect_string_omit_overlap.php | 114 ++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 ++
2 files changed, 123 insertions(+)
create mode 100644 dlp/src/inspect_string_omit_overlap.php
diff --git a/dlp/src/inspect_string_omit_overlap.php b/dlp/src/inspect_string_omit_overlap.php
new file mode 100644
index 0000000000..d3926fa3b6
--- /dev/null
+++ b/dlp/src/inspect_string_omit_overlap.php
@@ -0,0 +1,114 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $personName = (new InfoType())
+ ->setName('PERSON_NAME');
+ $emailAddress = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $infoTypes = [$personName, $emailAddress];
+
+ // Exclude EMAIL_ADDRESS matches
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_PARTIAL_MATCH)
+ ->setExcludeInfoTypes((new ExcludeInfoTypes())
+ ->setInfoTypes([$emailAddress])
+ );
+
+ // Construct a ruleset that applies the exclusion rule to the PERSON_NAME infotype.
+ // If a PERSON_NAME match overlaps with an EMAIL_ADDRESS match, the PERSON_NAME match will
+ // be excluded.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$personName])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_string_omit_overlap]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 009bcbc0de..7e1eea7a42 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectStringOmitOverlap()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_omit_overlap', [
+ self::$projectId,
+ 'james@example.org is an email.'
+ ]);
+ $this->assertStringContainsString('Info type: EMAIL_ADDRESS', $output);
+ }
+
public function testInspectStringCustomOmitOverlap()
{
$output = $this->runFunctionSnippet('inspect_string_custom_omit_overlap', [
From 012ce874514d7e4125c89861c522b3dff2455ce4 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 24 Apr 2023 21:15:43 +0530
Subject: [PATCH 010/285] feat(dlp): inspect data with a custom regex (#1797)
---
dlp/src/inspect_custom_regex.php | 98 ++++++++++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 +++
2 files changed, 107 insertions(+)
create mode 100644 dlp/src/inspect_custom_regex.php
diff --git a/dlp/src/inspect_custom_regex.php b/dlp/src/inspect_custom_regex.php
new file mode 100644
index 0000000000..6cef52d044
--- /dev/null
+++ b/dlp/src/inspect_custom_regex.php
@@ -0,0 +1,98 @@
+setValue($textToInspect);
+
+ // Specify the regex pattern the inspection will look for.
+ $customRegexPattern = '[1-9]{3}-[1-9]{1}-[1-9]{5}';
+
+ // Construct the custom regex detector.
+ $cMrnDetector = (new InfoType())
+ ->setName('C_MRN');
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($cMrnDetector)
+ ->setRegex((new Regex())
+ ->setPattern($customRegexPattern))
+ ->setLikelihood(Likelihood::POSSIBLE);
+
+ // Construct the configuration for the Inspect request.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_custom_regex]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 7e1eea7a42..0cbba8b66a 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectCustomRegex()
+ {
+ $output = $this->runFunctionSnippet('inspect_custom_regex', [
+ self::$projectId,
+ 'Patients MRN 444-5-22222'
+ ]);
+ $this->assertStringContainsString('Info type: C_MRN', $output);
+ }
+
public function testInspectStringOmitOverlap()
{
$output = $this->runFunctionSnippet('inspect_string_omit_overlap', [
From 2dd12a03baee23ba11d3f936687f5d7833836122 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 24 Apr 2023 22:06:48 +0530
Subject: [PATCH 011/285] feat(dlp): de-identify data redacting with matched
input values (#1801)
---
dlp/src/deidentify_redact.php | 95 +++++++++++++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 ++++
2 files changed, 104 insertions(+)
create mode 100644 dlp/src/deidentify_redact.php
diff --git a/dlp/src/deidentify_redact.php b/dlp/src/deidentify_redact.php
new file mode 100644
index 0000000000..8e125e7b00
--- /dev/null
+++ b/dlp/src/deidentify_redact.php
@@ -0,0 +1,95 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $infoType = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$infoType]);
+
+ // Define type of de-identification.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setRedactConfig(new RedactConfig());
+
+ // Associate de-identification type with info type.
+ $transformation = (new InfoTypeTransformation())
+ ->setInfoTypes([$infoType])
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ // Construct the configuration for the Redact request and list all desired transformations.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations((new InfoTypeTransformations())
+ ->setTransformations([$transformation]));
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print results
+ printf('Text after redaction: %s', $response->getItem()->getValue());
+}
+# [END dlp_deidentify_redact]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 0cbba8b66a..6f567b13d1 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testDeidentifyRedact()
+ {
+ $output = $this->runFunctionSnippet('deidentify_redact', [
+ self::$projectId,
+ 'My name is Alicia Abernathy, and my email address is aabernathy@example.com'
+ ]);
+ $this->assertStringNotContainsString('aabernathy@example.com', $output);
+ }
+
public function testInspectCustomRegex()
{
$output = $this->runFunctionSnippet('inspect_custom_regex', [
From 9154f317f491a639af101db7ced5c43cbd2857c6 Mon Sep 17 00:00:00 2001
From: Nicholas Cook
Date: Mon, 24 Apr 2023 09:59:18 -0700
Subject: [PATCH 012/285] chore(MediaTranscoder): remove restriction of JPEGs
only for overlay images (#1810)
---
media/transcoder/src/create_job_with_animated_overlay.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/media/transcoder/src/create_job_with_animated_overlay.php b/media/transcoder/src/create_job_with_animated_overlay.php
index 3fbc97aaf8..493a5dd570 100644
--- a/media/transcoder/src/create_job_with_animated_overlay.php
+++ b/media/transcoder/src/create_job_with_animated_overlay.php
@@ -41,7 +41,7 @@
* @param string $projectId The ID of your Google Cloud Platform project.
* @param string $location The location of the job.
* @param string $inputUri Uri of the video in the Cloud Storage bucket.
- * @param string $overlayImageUri Uri of the JPEG image for the overlay in the Cloud Storage bucket. Must be a JPEG.
+ * @param string $overlayImageUri Uri of the image for the overlay in the Cloud Storage bucket.
* @param string $outputUri Uri of the video output folder in the Cloud Storage bucket.
*/
function create_job_with_animated_overlay($projectId, $location, $inputUri, $overlayImageUri, $outputUri)
From 7aa4b14107d60211587b8ccf0d6b61960a132744 Mon Sep 17 00:00:00 2001
From: Nicholas Cook
Date: Mon, 24 Apr 2023 10:00:45 -0700
Subject: [PATCH 013/285] chore(MediaTranscoder): remove restriction of JPEGs
only for overlay images (#1809)
---
media/transcoder/src/create_job_with_static_overlay.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/media/transcoder/src/create_job_with_static_overlay.php b/media/transcoder/src/create_job_with_static_overlay.php
index dae4758101..0897bd1564 100644
--- a/media/transcoder/src/create_job_with_static_overlay.php
+++ b/media/transcoder/src/create_job_with_static_overlay.php
@@ -41,7 +41,7 @@
* @param string $projectId The ID of your Google Cloud Platform project.
* @param string $location The location of the job.
* @param string $inputUri Uri of the video in the Cloud Storage bucket.
- * @param string $overlayImageUri Uri of the JPEG image for the overlay in the Cloud Storage bucket. Must be a JPEG.
+ * @param string $overlayImageUri Uri of the image for the overlay in the Cloud Storage bucket.
* @param string $outputUri Uri of the video output folder in the Cloud Storage bucket.
*/
function create_job_with_static_overlay($projectId, $location, $inputUri, $overlayImageUri, $outputUri)
From 83c48738d59d6ce2fd8f3265314d1af5f709b226 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Tue, 25 Apr 2023 05:49:19 +0530
Subject: [PATCH 014/285] feat(dlp): inspect data with a hotword rule (#1800)
---
dlp/src/inspect_hotword_rule.php | 127 +++++++++++++++++++++++++++++++
dlp/test/dlpTest.php | 9 +++
2 files changed, 136 insertions(+)
create mode 100644 dlp/src/inspect_hotword_rule.php
diff --git a/dlp/src/inspect_hotword_rule.php b/dlp/src/inspect_hotword_rule.php
new file mode 100644
index 0000000000..21a2b4b133
--- /dev/null
+++ b/dlp/src/inspect_hotword_rule.php
@@ -0,0 +1,127 @@
+setValue($textToInspect);
+
+ // Specify the regex pattern the inspection will look for.
+ $customRegexPattern = '[1-9]{3}-[1-9]{1}-[1-9]{5}';
+ $hotwordRegexPattern = '(?i)(mrn|medical)(?-i)';
+
+ // Construct the custom regex detector.
+ $cMrnDetector = (new InfoType())
+ ->setName('C_MRN');
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($cMrnDetector)
+ ->setLikelihood(Likelihood::POSSIBLE)
+ ->setRegex((new Regex())
+ ->setPattern($customRegexPattern));
+
+ // Specify hotword likelihood adjustment.
+ $likelihoodAdjustment = (new LikelihoodAdjustment())
+ ->setFixedLikelihood(Likelihood::VERY_LIKELY);
+
+ // Specify a window around a finding to apply a detection rule.
+ $proximity = (new Proximity())
+ ->setWindowBefore(10);
+
+ $hotwordRule = (new HotwordRule())
+ ->setHotwordRegex((new Regex())
+ ->setPattern($hotwordRegexPattern))
+ ->setLikelihoodAdjustment($likelihoodAdjustment)
+ ->setProximity($proximity);
+
+ // Construct rule set for the inspect config.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$cMrnDetector])
+ ->setRules([
+ (new InspectionRule())
+ ->setHotwordRule($hotwordRule)
+ ]);
+
+ // Construct the configuration for the Inspect request.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_hotword_rule]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 6f567b13d1..70e2d648c6 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -259,6 +259,15 @@ public function testJobs()
$this->assertStringContainsString('Successfully deleted job ' . $jobId, $output);
}
+ public function testInspectHotwordRules()
+ {
+ $output = $this->runFunctionSnippet('inspect_hotword_rule', [
+ self::$projectId,
+ "Patient's MRN 444-5-22222 and just a number 333-2-33333"
+ ]);
+ $this->assertStringContainsString('Info type: C_MRN', $output);
+ }
+
public function testDeidentifyRedact()
{
$output = $this->runFunctionSnippet('deidentify_redact', [
From a28ed8f151a2b896ab0a880f469552eaa9a1291f Mon Sep 17 00:00:00 2001
From: Alejandro Leal
Date: Mon, 24 Apr 2023 20:43:43 -0400
Subject: [PATCH 015/285] chore(docs): fix typo in CONTRIBUTING.md (#1808)
---
CONTRIBUTING.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8cf828e51b..c1f62d50fd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -59,7 +59,7 @@ composer install
### Environment variables
Some tests require specific environment variables to run. PHPUnit will skip the tests
if these environment variables are not found. Run `phpunit -v` for a message detailing
-which environment variables are missing. Then you can set those environent variables
+which environment variables are missing. Then you can set those environment variables
to run against any sample project as follows:
```
From 6232bd35911c0c29d52aaacd1ff6f103dea64893 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 1 May 2023 22:31:08 +0530
Subject: [PATCH 016/285] feat(dlp): inspect a string for sensitive data by
using multiple rules (#1817)
---
dlp/src/inspect_string_multiple_rules.php | 142 ++++++++++++++++++++++
dlp/test/dlpTest.php | 40 ++++++
2 files changed, 182 insertions(+)
create mode 100644 dlp/src/inspect_string_multiple_rules.php
diff --git a/dlp/src/inspect_string_multiple_rules.php b/dlp/src/inspect_string_multiple_rules.php
new file mode 100644
index 0000000000..01a768d686
--- /dev/null
+++ b/dlp/src/inspect_string_multiple_rules.php
@@ -0,0 +1,142 @@
+setValue($textToInspect);
+
+ // Construct hotword rules
+ $patientRule = (new HotwordRule())
+ ->setHotwordRegex((new Regex())
+ ->setPattern('patient'))
+ ->setProximity((new Proximity())
+ ->setWindowBefore(10))
+ ->setLikelihoodAdjustment((new LikelihoodAdjustment())
+ ->setFixedLikelihood(Likelihood::VERY_LIKELY));
+
+ $doctorRule = (new HotwordRule())
+ ->setHotwordRegex((new Regex())
+ ->setPattern('doctor'))
+ ->setProximity((new Proximity())
+ ->setWindowBefore(10))
+ ->setLikelihoodAdjustment((new LikelihoodAdjustment())
+ ->setFixedLikelihood(Likelihood::VERY_UNLIKELY));
+
+ // Construct exclusion rules
+ $wordList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords(['Quasimodo']));
+
+ $quasimodoRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_PARTIAL_MATCH)
+ ->setDictionary($wordList);
+
+ $redactedRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_PARTIAL_MATCH)
+ ->setRegex((new Regex())
+ ->setPattern('REDACTED'));
+
+ // Specify the exclusion rule and build-in info type the inspection will look for.
+ $personName = (new InfoType())
+ ->setName('PERSON_NAME');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$personName])
+ ->setRules([
+ (new InspectionRule())
+ ->setHotwordRule($patientRule),
+ (new InspectionRule())
+ ->setHotwordRule($doctorRule),
+ (new InspectionRule())
+ ->setExclusionRule($quasimodoRule),
+ (new InspectionRule())
+ ->setExclusionRule($redactedRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$personName])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_string_multiple_rules]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 70e2d648c6..d1cc0399d3 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -357,4 +357,44 @@ public function testInspectStringWithExclusionDict()
$this->assertStringContainsString('Quote: gary@example.com', $output);
$this->assertStringNotContainsString('Quote: example@example.com', $output);
}
+
+ public function testInspectStringMultipleRulesPatientRule()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_multiple_rules', [
+ self::$projectId,
+ 'patient: Jane Doe'
+ ]);
+
+ $this->assertStringContainsString('Info type: PERSON_NAME', $output);
+ }
+
+ public function testInspectStringMultipleRulesDoctorRule()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_multiple_rules', [
+ self::$projectId,
+ 'doctor: Jane Doe'
+ ]);
+
+ $this->assertStringContainsString('No findings.', $output);
+ }
+
+ public function testInspectStringMultipleRulesQuasimodoRule()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_multiple_rules', [
+ self::$projectId,
+ 'patient: Quasimodo'
+ ]);
+
+ $this->assertStringContainsString('No findings.', $output);
+ }
+
+ public function testInspectStringMultipleRulesRedactedRule()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_multiple_rules', [
+ self::$projectId,
+ 'name of patient: REDACTED'
+ ]);
+
+ $this->assertStringContainsString('No findings.', $output);
+ }
}
From 08fb26c07a43d7b74bb8aa672f1b2f6f5eeb11f9 Mon Sep 17 00:00:00 2001
From: Ajumal
Date: Wed, 3 May 2023 15:53:21 +0530
Subject: [PATCH 017/285] chore(Pubsub): Fix Avro samples (#1813)
---
pubsub/api/src/publish_avro_records.php | 12 ++++--------
pubsub/api/src/subscribe_avro_records.php | 12 +++++++-----
pubsub/api/test/SchemaTest.php | 1 +
3 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/pubsub/api/src/publish_avro_records.php b/pubsub/api/src/publish_avro_records.php
index 9a10f10530..bd68219c9e 100644
--- a/pubsub/api/src/publish_avro_records.php
+++ b/pubsub/api/src/publish_avro_records.php
@@ -29,7 +29,7 @@
use AvroStringIO;
use AvroSchema;
use AvroIODatumWriter;
-use AvroDataIOWriter;
+use AvroIOBinaryEncoder;
/**
* Publish a message using an AVRO schema.
@@ -81,14 +81,10 @@ function publish_avro_records($projectId, $topicId, $definitionFile)
$io = new AvroStringIO();
$schema = AvroSchema::parse($definition);
$writer = new AvroIODatumWriter($schema);
- $dataWriter = new AvroDataIOWriter($io, $writer, $schema);
+ $encoder = new AvroIOBinaryEncoder($io);
+ $writer->write($messageData, $encoder);
- $dataWriter->append($messageData);
-
- $dataWriter->close();
-
- // AVRO binary data must be base64-encoded.
- $encodedMessageData = base64_encode($io->string());
+ $encodedMessageData = $io->string();
} else {
// encode as JSON.
$encodedMessageData = json_encode($messageData);
diff --git a/pubsub/api/src/subscribe_avro_records.php b/pubsub/api/src/subscribe_avro_records.php
index f979341891..52b65586ef 100644
--- a/pubsub/api/src/subscribe_avro_records.php
+++ b/pubsub/api/src/subscribe_avro_records.php
@@ -31,13 +31,14 @@
* @param string $projectId
* @param string $subscriptionId
*/
-function subscribe_avro_records($projectId, $subscriptionId)
+function subscribe_avro_records($projectId, $subscriptionId, $definitionFile)
{
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);
$subscription = $pubsub->subscription($subscriptionId);
+ $definition = file_get_contents($definitionFile);
$messages = $subscription->pull();
foreach ($messages as $message) {
@@ -45,10 +46,11 @@ function subscribe_avro_records($projectId, $subscriptionId)
$encoding = $message->attribute('googclient_schemaencoding');
switch ($encoding) {
case 'BINARY':
- $ioReader = new \AvroStringIO(base64_decode($message->data()));
- $dataReader = new \AvroDataIOReader($ioReader, new \AvroIODatumReader());
-
- $decodedMessageData = json_encode($dataReader->data());
+ $io = new \AvroStringIO($message->data());
+ $schema = \AvroSchema::parse($definition);
+ $reader = new \AvroIODatumReader($schema);
+ $decoder = new \AvroIOBinaryDecoder($io);
+ $decodedMessageData = json_encode($reader->read($decoder));
break;
case 'JSON':
$decodedMessageData = $message->data();
diff --git a/pubsub/api/test/SchemaTest.php b/pubsub/api/test/SchemaTest.php
index 9465908e9a..c7ea7bd686 100644
--- a/pubsub/api/test/SchemaTest.php
+++ b/pubsub/api/test/SchemaTest.php
@@ -210,6 +210,7 @@ public function testPublishAndSubscribeAvro($encoding)
$subscribeOutput = $this->runFunctionSnippet('subscribe_avro_records', [
self::$projectId,
$subscriptionId,
+ self::AVRO_DEFINITION,
]);
$this->assertStringContainsString(
From 2485b77bebdbe1cba465efcef77d70ec17563963 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Thu, 4 May 2023 20:58:47 +0530
Subject: [PATCH 018/285] feat(dlp): inspect a string with an exclusion
dictionary substring (#1816)
---
...t_string_with_exclusion_dict_substring.php | 118 ++++++++++++++++++
dlp/test/dlpTest.php | 15 +++
2 files changed, 133 insertions(+)
create mode 100644 dlp/src/inspect_string_with_exclusion_dict_substring.php
diff --git a/dlp/src/inspect_string_with_exclusion_dict_substring.php b/dlp/src/inspect_string_with_exclusion_dict_substring.php
new file mode 100644
index 0000000000..836e0a0a92
--- /dev/null
+++ b/dlp/src/inspect_string_with_exclusion_dict_substring.php
@@ -0,0 +1,118 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $infotypes = [
+ (new InfoType())->setName('PHONE_NUMBER'),
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('DOMAIN_NAME'),
+ (new InfoType())->setName('PERSON_NAME'),
+ ];
+
+ // Exclude matches from the specified excludedSubstringList.
+ $excludedSubstringList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords($excludedSubStringArray));
+
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_PARTIAL_MATCH)
+ ->setDictionary($excludedSubstringList);
+
+ // Construct a ruleset that applies the exclusion rule to the EMAIL_ADDRESSES infotype.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes($infotypes)
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infotypes)
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_string_with_exclusion_dict_substring]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index d1cc0399d3..ac9eb73bbb 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -358,6 +358,21 @@ public function testInspectStringWithExclusionDict()
$this->assertStringNotContainsString('Quote: example@example.com', $output);
}
+ public function testInspectStringWithExclusionDictSubstring()
+ {
+ $excludedSubStringArray = ['Test'];
+ $output = $this->runFunctionSnippet('inspect_string_with_exclusion_dict_substring', [
+ self::$projectId,
+ 'Some email addresses: gary@example.com, TEST@example.com',
+ $excludedSubStringArray
+ ]);
+ $this->assertStringContainsString('Quote: gary@example.com', $output);
+ $this->assertStringContainsString('Info type: EMAIL_ADDRESS', $output);
+ $this->assertStringContainsString('Quote: example.com', $output);
+ $this->assertStringContainsString('Info type: DOMAIN_NAME', $output);
+ $this->assertStringNotContainsString('TEST@example.com', $output);
+ }
+
public function testInspectStringMultipleRulesPatientRule()
{
$output = $this->runFunctionSnippet('inspect_string_multiple_rules', [
From 7cf51ab5e37fa1d7d1756187d3c0ec79a0d8875b Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Thu, 4 May 2023 20:59:20 +0530
Subject: [PATCH 019/285] feat(dlp): implement
dlp_inspect_string_custom_excluding_substring (#1819)
---
...pect_string_custom_excluding_substring.php | 119 ++++++++++++++++++
dlp/test/dlpTest.php | 14 +++
2 files changed, 133 insertions(+)
create mode 100644 dlp/src/inspect_string_custom_excluding_substring.php
diff --git a/dlp/src/inspect_string_custom_excluding_substring.php b/dlp/src/inspect_string_custom_excluding_substring.php
new file mode 100644
index 0000000000..c0ea1de49a
--- /dev/null
+++ b/dlp/src/inspect_string_custom_excluding_substring.php
@@ -0,0 +1,119 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $customerNameDetector = (new InfoType())
+ ->setName('CUSTOM_NAME_DETECTOR');
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($customerNameDetector)
+ ->setRegex((new Regex())
+ ->setPattern($customDetectorPattern));
+
+ // Exclude partial matches from the specified excludedSubstringList.
+ $excludedSubstringList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords(['Jimmy']));
+
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_PARTIAL_MATCH)
+ ->setDictionary($excludedSubstringList);
+
+ // Construct a ruleset that applies the exclusion rule.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$customerNameDetector])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_string_custom_excluding_substring]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index ac9eb73bbb..c7b42417f7 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -412,4 +412,18 @@ public function testInspectStringMultipleRulesRedactedRule()
$this->assertStringContainsString('No findings.', $output);
}
+
+ public function testInspectStringCustomExcludingSubstring()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_custom_excluding_substring', [
+ self::$projectId,
+ 'Name: Doe, John. Name: Example, Jimmy'
+ ]);
+
+ $this->assertStringContainsString('Info type: CUSTOM_NAME_DETECTOR', $output);
+ $this->assertStringContainsString('Doe', $output);
+ $this->assertStringContainsString('John', $output);
+ $this->assertStringNotContainsString('Jimmy', $output);
+ $this->assertStringNotContainsString('Example', $output);
+ }
}
From 6bd288e72b85ba8f129417092842ca9a563d1ab1 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Thu, 4 May 2023 21:21:15 +0530
Subject: [PATCH 020/285] chore(dlp): implement
dlp_inspect_string_with_exclusion_regex (#1818)
---
.../inspect_string_with_exclusion_regex.php | 115 ++++++++++++++++++
dlp/test/dlpTest.php | 11 ++
2 files changed, 126 insertions(+)
create mode 100644 dlp/src/inspect_string_with_exclusion_regex.php
diff --git a/dlp/src/inspect_string_with_exclusion_regex.php b/dlp/src/inspect_string_with_exclusion_regex.php
new file mode 100644
index 0000000000..942183751d
--- /dev/null
+++ b/dlp/src/inspect_string_with_exclusion_regex.php
@@ -0,0 +1,115 @@
+setValue($textToInspect);
+
+ // Specify the type of info the inspection will look for.
+ $infotypes = [
+ (new InfoType())->setName('PHONE_NUMBER'),
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('CREDIT_CARD_NUMBER'),
+ ];
+
+ // Exclude matches from the specified excludedRegex.
+ $excludedRegex = '.+@example.com';
+ $exclusionRule = (new ExclusionRule())
+ ->setMatchingType(MatchingType::MATCHING_TYPE_FULL_MATCH)
+ ->setRegex((new Regex())
+ ->setPattern($excludedRegex));
+
+ // Construct a ruleset that applies the exclusion rule to the EMAIL_ADDRESSES infotype.
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([
+ (new InfoType())
+ ->setName('EMAIL_ADDRESS')
+ ])
+ ->setRules([
+ (new InspectionRule())
+ ->setExclusionRule($exclusionRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infotypes)
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet]);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_string_with_exclusion_regex]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index c7b42417f7..0639ae80fe 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -413,6 +413,17 @@ public function testInspectStringMultipleRulesRedactedRule()
$this->assertStringContainsString('No findings.', $output);
}
+ public function testInspectStringWithExclusionRegex()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_with_exclusion_regex', [
+ self::$projectId,
+ 'Some email addresses: gary@example.com, bob@example.org'
+ ]);
+
+ $this->assertStringContainsString('Quote: bob@example.org', $output);
+ $this->assertStringNotContainsString('gray@example.com', $output);
+ }
+
public function testInspectStringCustomExcludingSubstring()
{
$output = $this->runFunctionSnippet('inspect_string_custom_excluding_substring', [
From 5d5d7b52ed5928cc41759ddf9864b640bcebe4a2 Mon Sep 17 00:00:00 2001
From: Vishwaraj Anand
Date: Sat, 6 May 2023 00:11:30 +0530
Subject: [PATCH 021/285] feat(pubsub): publish with retrySettings (#1822)
---
.../api/src/publish_with_retry_settings.php | 61 +++++++++++++++++++
pubsub/api/test/pubsubTest.php | 13 ++++
2 files changed, 74 insertions(+)
create mode 100644 pubsub/api/src/publish_with_retry_settings.php
diff --git a/pubsub/api/src/publish_with_retry_settings.php b/pubsub/api/src/publish_with_retry_settings.php
new file mode 100644
index 0000000000..cbcfe73c88
--- /dev/null
+++ b/pubsub/api/src/publish_with_retry_settings.php
@@ -0,0 +1,61 @@
+ $projectId,
+ ]);
+
+ $topic = $pubsub->topic($topicName);
+ $retrySettings = [
+ 'initialRetryDelayMillis' => 100,
+ 'retryDelayMultiplier' => 5,
+ 'maxRetryDelayMillis' => 60000,
+ 'initialRpcTimeoutMillis' => 1000,
+ 'rpcTimeoutMultiplier' => 1,
+ 'maxRpcTimeoutMillis' => 600000,
+ 'totalTimeoutMillis' => 600000
+ ];
+ $topic->publish((new MessageBuilder)->setData($message)->build(), [
+ 'retrySettings' => $retrySettings
+ ]);
+
+ print('Message published with retry settings' . PHP_EOL);
+}
+# [END pubsub_publisher_retry_settings]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/test/pubsubTest.php b/pubsub/api/test/pubsubTest.php
index 9bff54ef4f..98c792ed66 100644
--- a/pubsub/api/test/pubsubTest.php
+++ b/pubsub/api/test/pubsubTest.php
@@ -169,6 +169,19 @@ public function testTopicMessage()
$this->assertRegExp('/Message published/', $output);
}
+ public function testTopicMessageWithRetrySettings()
+ {
+ $topic = $this->requireEnv('GOOGLE_PUBSUB_TOPIC');
+
+ $output = $this->runFunctionSnippet('publish_with_retry_settings', [
+ self::$projectId,
+ $topic,
+ 'This is a test message',
+ ]);
+
+ $this->assertRegExp('/Message published with retry settings/', $output);
+ }
+
public function testListSubscriptions()
{
$subscription = $this->requireEnv('GOOGLE_PUBSUB_SUBSCRIPTION');
From 399ea733e2979c4ddbb63ed3258ed9ccd639daec Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Sat, 6 May 2023 05:58:11 +0200
Subject: [PATCH 022/285] fix(deps): update dependency google/analytics-data to
^0.10.0 (#1831)
---
analyticsdata/quickstart_oauth2/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/analyticsdata/quickstart_oauth2/composer.json b/analyticsdata/quickstart_oauth2/composer.json
index fa31a3c25d..7574617f39 100644
--- a/analyticsdata/quickstart_oauth2/composer.json
+++ b/analyticsdata/quickstart_oauth2/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/analytics-data": "^0.9.0",
+ "google/analytics-data": "^0.10.0",
"ext-bcmath": "*"
}
}
From 3e85b5439656c136f4de53511307867bd4104d85 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 8 May 2023 21:58:58 +0530
Subject: [PATCH 023/285] feat(dlp): implemented dlp_deidentify_replace (#1825)
---
dlp/src/deidentify_replace.php | 105 +++++++++++++++++++++++++++++++++
dlp/test/dlpTest.php | 11 ++++
2 files changed, 116 insertions(+)
create mode 100644 dlp/src/deidentify_replace.php
diff --git a/dlp/src/deidentify_replace.php b/dlp/src/deidentify_replace.php
new file mode 100644
index 0000000000..6a036afcca
--- /dev/null
+++ b/dlp/src/deidentify_replace.php
@@ -0,0 +1,105 @@
+setValue($string);
+
+ // Specify the type of info the inspection will look for.
+ $emailAddressInfoType = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+
+ // Create the configuration object
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$emailAddressInfoType]);
+
+ // Specify replacement string to be used for the finding.
+ $replaceValueConfig = (new ReplaceValueConfig())
+ ->setNewValue((new Value())
+ ->setStringValue('[email-address]'));
+
+ // Define type of deidentification as replacement.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceConfig($replaceValueConfig);
+
+ // Associate deidentification type with info type.
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes([$emailAddressInfoType]);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Construct the configuration for the Redact request and list all desired transformations.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content,
+ 'inspectConfig' => $inspectConfig
+ ]);
+
+ // Print the results
+ printf('Deidentified content: %s' . PHP_EOL, $response->getItem()->getValue());
+}
+# [END dlp_deidentify_replace]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 0639ae80fe..0130c612cd 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -437,4 +437,15 @@ public function testInspectStringCustomExcludingSubstring()
$this->assertStringNotContainsString('Jimmy', $output);
$this->assertStringNotContainsString('Example', $output);
}
+
+ public function testDeidentifyReplace()
+ {
+ $string = 'My name is Alicia Abernathy, and my email address is aabernathy@example.com.';
+ $output = $this->runFunctionSnippet('deidentify_replace', [
+ self::$projectId,
+ $string
+ ]);
+ $this->assertStringContainsString('[email-address]', $output);
+ $this->assertNotEquals($output, $string);
+ }
}
From 7a93622fd19eadb158c929d75b640e4f95828912 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Thu, 11 May 2023 21:09:39 +0530
Subject: [PATCH 024/285] feat(dlp): sample for de-identify table samples
(#1837)
---
dlp/src/deidentify_table_bucketing.php | 139 ++++++++++++++
.../deidentify_table_condition_infotypes.php | 169 ++++++++++++++++++
.../deidentify_table_condition_masking.php | 154 ++++++++++++++++
dlp/src/deidentify_table_infotypes.php | 146 +++++++++++++++
dlp/src/deidentify_table_row_suppress.php | 139 ++++++++++++++
dlp/test/data/table1.csv | 4 +
dlp/test/data/table2.csv | 4 +
dlp/test/dlpTest.php | 127 +++++++++++++
8 files changed, 882 insertions(+)
create mode 100644 dlp/src/deidentify_table_bucketing.php
create mode 100644 dlp/src/deidentify_table_condition_infotypes.php
create mode 100644 dlp/src/deidentify_table_condition_masking.php
create mode 100644 dlp/src/deidentify_table_infotypes.php
create mode 100644 dlp/src/deidentify_table_row_suppress.php
create mode 100644 dlp/test/data/table1.csv
create mode 100644 dlp/test/data/table2.csv
diff --git a/dlp/src/deidentify_table_bucketing.php b/dlp/src/deidentify_table_bucketing.php
new file mode 100644
index 0000000000..9ff0a8a44e
--- /dev/null
+++ b/dlp/src/deidentify_table_bucketing.php
@@ -0,0 +1,139 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $contentItem = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify how the content should be de-identified.
+ $fixedSizeBucketingConfig = (new FixedSizeBucketingConfig())
+ ->setBucketSize(10)
+ ->setLowerBound((new Value())
+ ->setIntegerValue(10))
+ ->setUpperBound((new Value())
+ ->setIntegerValue(100));
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setFixedSizeBucketingConfig($fixedSizeBucketingConfig);
+
+ // Specify the field to to apply bucketing transform on
+ $fieldId = (new FieldId())
+ ->setName('HAPPINESS_SCORE');
+
+ // Associate the encryption with the specified field.
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields([$fieldId]);
+
+ $recordTransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ // Create the deidentification configuration object
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordTransformations);
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print results
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf($outputCsvFile);
+}
+# [END dlp_deidentify_table_bucketing]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_condition_infotypes.php b/dlp/src/deidentify_table_condition_infotypes.php
new file mode 100644
index 0000000000..aecac2b573
--- /dev/null
+++ b/dlp/src/deidentify_table_condition_infotypes.php
@@ -0,0 +1,169 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the type of info the inspection will look for.
+ $personNameInfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+
+ // Specify that findings should be replaced with corresponding info type name.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceWithInfoTypeConfig(new ReplaceWithInfoTypeConfig());
+
+ // Associate info type with the replacement strategy
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes([$personNameInfoType]);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Specify fields to be de-identified.
+ $fieldIds = [
+ (new FieldId())->setName('PATIENT'),
+ (new FieldId())->setName('FACTOID'),
+ ];
+
+ // Specify when the above fields should be de-identified.
+ $condition = (new Condition())
+ ->setField((new FieldId())
+ ->setName('AGE'))
+ ->setOperator(RelationalOperator::GREATER_THAN)
+ ->setValue((new Value())
+ ->setIntegerValue(89));
+
+ // Apply the condition to records
+ $recordCondition = (new RecordCondition())
+ ->setExpressions((new Expressions())
+ ->setConditions((new Conditions())
+ ->setConditions([$condition])
+ )
+ );
+
+ // Associate the de-identification and conditions with the specified fields.
+ $fieldTransformation = (new FieldTransformation())
+ ->setInfoTypeTransformations($infoTypeTransformations)
+ ->setFields($fieldIds)
+ ->setCondition($recordCondition);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print results
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf($outputCsvFile);
+}
+# [END dlp_deidentify_table_condition_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_condition_masking.php b/dlp/src/deidentify_table_condition_masking.php
new file mode 100644
index 0000000000..b28b1f1541
--- /dev/null
+++ b/dlp/src/deidentify_table_condition_masking.php
@@ -0,0 +1,154 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify how the content should be de-identified.
+ $characterMaskConfig = (new CharacterMaskConfig())
+ ->setMaskingCharacter('*');
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCharacterMaskConfig($characterMaskConfig);
+
+ // Specify field to be de-identified.
+ $fieldId = (new FieldId())
+ ->setName('HAPPINESS_SCORE');
+
+ // Specify when the above fields should be de-identified.
+ $condition = (new Condition())
+ ->setField((new FieldId())
+ ->setName('AGE'))
+ ->setOperator(RelationalOperator::GREATER_THAN)
+ ->setValue((new Value())
+ ->setIntegerValue(89));
+
+ // Apply the condition to records
+ $recordCondition = (new RecordCondition())
+ ->setExpressions((new Expressions())
+ ->setConditions((new Conditions())
+ ->setConditions([$condition])
+ )
+ );
+
+ // Associate the de-identification and conditions with the specified fields.
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields([$fieldId])
+ ->setCondition($recordCondition);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print results
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('After de-identify the table data (Output File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_condition_masking]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_infotypes.php b/dlp/src/deidentify_table_infotypes.php
new file mode 100644
index 0000000000..1185d42874
--- /dev/null
+++ b/dlp/src/deidentify_table_infotypes.php
@@ -0,0 +1,146 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify the content to be inspected.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the type of info the inspection will look for.
+ $personNameInfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+
+ // Specify that findings should be replaced with corresponding info type name.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceWithInfoTypeConfig(new ReplaceWithInfoTypeConfig());
+
+ // Associate info type with the replacement strategy
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes([$personNameInfoType]);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Specify fields to be de-identified.
+ $fieldIds = [
+ (new FieldId())->setName('PATIENT'),
+ (new FieldId())->setName('FACTOID'),
+ ];
+
+ // Associate the de-identification and transformation with the specified fields.
+ $fieldTransformation = (new FieldTransformation())
+ ->setInfoTypeTransformations($infoTypeTransformations)
+ ->setFields($fieldIds);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('After de-identify the table data (Output File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_row_suppress.php b/dlp/src/deidentify_table_row_suppress.php
new file mode 100644
index 0000000000..f6fb22a36f
--- /dev/null
+++ b/dlp/src/deidentify_table_row_suppress.php
@@ -0,0 +1,139 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify when the content should be de-identified.
+ $condition = (new Condition())
+ ->setField((new FieldId())
+ ->setName('AGE'))
+ ->setOperator(RelationalOperator::GREATER_THAN)
+ ->setValue((new Value())
+ ->setIntegerValue(89));
+
+ // Apply the condition to record suppression.
+ $recordSuppressions = (new RecordSuppression())
+ ->setCondition((new RecordCondition())
+ ->setExpressions((new Expressions())
+ ->setConditions((new Conditions())
+ ->setConditions([$condition])
+ )
+ )
+ );
+
+ // Use record suppression as the only transformation
+ $recordtransformations = (new RecordTransformations())
+ ->setRecordSuppressions([$recordSuppressions]);
+
+ // Create the deidentification configuration object
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf($outputCsvFile);
+}
+# [END dlp_deidentify_table_row_suppress]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/data/table1.csv b/dlp/test/data/table1.csv
new file mode 100644
index 0000000000..e3ce64d50c
--- /dev/null
+++ b/dlp/test/data/table1.csv
@@ -0,0 +1,4 @@
+AGE,PATIENT,HAPPINESS_SCORE,FACTOID
+101,Charles Dickens,95,Charles Dickens name was a curse invented by Shakespeare.
+22,Jane Austen,21,There are 14 kisses in Jane Austen's novels.
+55,Mark Twain,75,Mark Twain loved cats.
\ No newline at end of file
diff --git a/dlp/test/data/table2.csv b/dlp/test/data/table2.csv
new file mode 100644
index 0000000000..965548b40c
--- /dev/null
+++ b/dlp/test/data/table2.csv
@@ -0,0 +1,4 @@
+AGE,PATIENT,HAPPINESS_SCORE
+101,Charles Dickens,95
+22,Jane Austen,21
+55,Mark Twain,75
\ No newline at end of file
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 0130c612cd..fa051e536b 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -448,4 +448,131 @@ public function testDeidentifyReplace()
$this->assertStringContainsString('[email-address]', $output);
$this->assertNotEquals($output, $string);
}
+
+ public function testDeidentifyTableInfotypes()
+ {
+ $inputCsvFile = __DIR__ . '/data/table1.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_infotypes_output_unitest.csv';
+ $output = $this->runFunctionSnippet('deidentify_table_infotypes', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile,
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString('[PERSON_NAME]', $csvLines_ouput[1]);
+ $this->assertStringNotContainsString('Charles Dickens', $csvLines_ouput[1]);
+
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableConditionMasking()
+ {
+ $inputCsvFile = __DIR__ . '/data/table2.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_condition_masking_output_unittest.csv';
+
+ $output = $this->runFunctionSnippet('deidentify_table_condition_masking', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile
+ ]);
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString('**', $csvLines_ouput[1]);
+
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableConditionInfotypes()
+ {
+ $inputCsvFile = __DIR__ . '/data/table1.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_condition_infotypes_output_unittest.csv';
+
+ $output = $this->runFunctionSnippet('deidentify_table_condition_infotypes', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($inputCsvFile),
+ sha1_file($outputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString('[PERSON_NAME]', $csvLines_ouput[1]);
+ $this->assertStringNotContainsString('Charles Dickens', $csvLines_ouput[1]);
+ $this->assertStringNotContainsString('[PERSON_NAME]', $csvLines_ouput[2]);
+ $this->assertStringContainsString('Jane Austen', $csvLines_ouput[2]);
+
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableBucketing()
+ {
+ $inputCsvFile = __DIR__ . '/data/table2.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_bucketing_output_unittest.csv';
+
+ $output = $this->runFunctionSnippet('deidentify_table_bucketing', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString('90:100', $csvLines_ouput[1]);
+ $this->assertStringContainsString('20:30', $csvLines_ouput[2]);
+ $this->assertStringContainsString('70:80', $csvLines_ouput[3]);
+
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableRowSuppress()
+ {
+ $inputCsvFile = __DIR__ . '/data/table2.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_row_suppress_output_unitest.csv';
+ $output = $this->runFunctionSnippet('deidentify_table_row_suppress', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile,
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertEquals(3, count($csvLines_ouput));
+ unlink($outputCsvFile);
+ }
}
From b97c8d804e9af0b4357c75b06bc35cca69f73794 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Wed, 17 May 2023 20:21:14 -0600
Subject: [PATCH 025/285] chore: upgrade to PHP 8.1 and PHP 8.2, drop support
for PHP 7.4 and below (#1838)
---
.kokoro/deploy_gae.cfg | 2 +-
.kokoro/deploy_gcf.cfg | 2 +-
.kokoro/deploy_misc.cfg | 2 +-
.kokoro/{php74.cfg => php81.cfg} | 2 +-
.kokoro/{php73.cfg => php82.cfg} | 2 +-
.kokoro/php_rest.cfg | 2 +-
.kokoro/system_tests.sh | 3 +
appengine/standard/errorreporting/README.md | 24 +++++---
appengine/standard/errorreporting/app.yaml | 2 +-
.../standard/errorreporting/composer.json | 7 ++-
appengine/standard/errorreporting/index.php | 5 +-
appengine/standard/errorreporting/php.ini | 1 -
appengine/standard/grpc/README.md | 2 +-
appengine/standard/grpc/app.yaml | 2 +-
.../standard/memorystore/test/DeployTest.php | 2 +-
appengine/standard/symfony-framework/app.yaml | 2 +-
asset/src/export_assets.php | 2 +-
asset/test/assetSearchTest.php | 20 ++++---
asset/test/assetTest.php | 33 +++++-----
auth/app.yaml | 2 +-
bigtable/src/create_cluster.php | 2 +-
.../src/create_cluster_autoscale_config.php | 2 +-
.../src/disable_cluster_autoscale_config.php | 2 +-
.../src/update_cluster_autoscale_config.php | 2 +-
cloud_sql/mysql/pdo/app.standard.yaml | 2 +-
cloud_sql/mysql/pdo/test/IntegrationTest.php | 3 -
cloud_sql/mysql/pdo/test/VotesTest.php | 3 +
cloud_sql/postgres/pdo/app.standard.yaml | 2 +-
.../postgres/pdo/test/IntegrationTest.php | 3 -
cloud_sql/postgres/pdo/test/VotesTest.php | 3 +
.../sqlserver/pdo/test/IntegrationTest.php | 3 -
cloud_sql/sqlserver/pdo/test/VotesTest.php | 3 +
compute/firewall/src/create_firewall_rule.php | 2 +-
compute/firewall/src/delete_firewall_rule.php | 2 +-
.../firewall/src/patch_firewall_priority.php | 2 +-
compute/instances/src/create_instance.php | 2 +-
.../create_instance_with_encryption_key.php | 2 +-
compute/instances/src/delete_instance.php | 2 +-
.../src/disable_usage_export_bucket.php | 2 +-
compute/instances/src/reset_instance.php | 2 +-
compute/instances/src/resume_instance.php | 2 +-
.../instances/src/set_usage_export_bucket.php | 2 +-
compute/instances/src/start_instance.php | 2 +-
.../start_instance_with_encryption_key.php | 2 +-
compute/instances/src/stop_instance.php | 2 +-
compute/instances/src/suspend_instance.php | 2 +-
compute/instances/test/instancesTest.php | 6 ++
dlp/README.md | 2 +-
dlp/test/dlpLongRunningTest.php | 18 +++---
dlp/test/dlpTest.php | 4 +-
language/test/quickstartTest.php | 4 +-
logging/test/loggingTest.php | 4 +-
media/transcoder/test/transcoderTest.php | 16 ++---
pubsub/api/test/pubsubTest.php | 60 +++++++++----------
servicedirectory/README.md | 2 +-
spanner/test/spannerBackupTest.php | 2 +-
storage/test/storageTest.php | 2 +-
storagetransfer/test/StorageTransferTest.php | 2 +-
testing/composer.json | 7 ++-
59 files changed, 165 insertions(+), 141 deletions(-)
rename .kokoro/{php74.cfg => php81.cfg} (87%)
rename .kokoro/{php73.cfg => php82.cfg} (87%)
delete mode 100644 appengine/standard/errorreporting/php.ini
diff --git a/.kokoro/deploy_gae.cfg b/.kokoro/deploy_gae.cfg
index 7b53066472..3b7a2d7645 100644
--- a/.kokoro/deploy_gae.cfg
+++ b/.kokoro/deploy_gae.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php74"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php80"
}
# Run the deployment tests
diff --git a/.kokoro/deploy_gcf.cfg b/.kokoro/deploy_gcf.cfg
index cb204a4808..243fbc7b69 100644
--- a/.kokoro/deploy_gcf.cfg
+++ b/.kokoro/deploy_gcf.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php74"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php80"
}
# Run the deployment tests
diff --git a/.kokoro/deploy_misc.cfg b/.kokoro/deploy_misc.cfg
index d5dee66881..8efc1b10f8 100644
--- a/.kokoro/deploy_misc.cfg
+++ b/.kokoro/deploy_misc.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php74"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php80"
}
# Run the deployment tests
diff --git a/.kokoro/php74.cfg b/.kokoro/php81.cfg
similarity index 87%
rename from .kokoro/php74.cfg
rename to .kokoro/php81.cfg
index c6409b06a7..1b7a81d36a 100644
--- a/.kokoro/php74.cfg
+++ b/.kokoro/php81.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php74"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php81"
}
# Give the docker image a unique project ID and credentials per PHP version
diff --git a/.kokoro/php73.cfg b/.kokoro/php82.cfg
similarity index 87%
rename from .kokoro/php73.cfg
rename to .kokoro/php82.cfg
index 7105905259..824663d40a 100644
--- a/.kokoro/php73.cfg
+++ b/.kokoro/php82.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php73"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php82"
}
# Give the docker image a unique project ID and credentials per PHP version
diff --git a/.kokoro/php_rest.cfg b/.kokoro/php_rest.cfg
index e2b32adcf2..650b018bfa 100644
--- a/.kokoro/php_rest.cfg
+++ b/.kokoro/php_rest.cfg
@@ -3,7 +3,7 @@
# Configure the docker image for kokoro-trampoline.
env_vars: {
key: "TRAMPOLINE_IMAGE"
- value: "gcr.io/cloud-devrel-kokoro-resources/php73"
+ value: "gcr.io/cloud-devrel-kokoro-resources/php80"
}
# Set this project to run REST tests only
diff --git a/.kokoro/system_tests.sh b/.kokoro/system_tests.sh
index 0b0a149f17..5c286a2ad1 100755
--- a/.kokoro/system_tests.sh
+++ b/.kokoro/system_tests.sh
@@ -59,5 +59,8 @@ fi
# Install global test dependencies
composer install -d testing/
+# Configure the current directory as a safe directory
+git config --global --add safe.directory $(pwd)
+
# Run tests
bash testing/run_test_suite.sh
diff --git a/appengine/standard/errorreporting/README.md b/appengine/standard/errorreporting/README.md
index 2952836525..009239871c 100644
--- a/appengine/standard/errorreporting/README.md
+++ b/appengine/standard/errorreporting/README.md
@@ -10,11 +10,15 @@ these two steps:
```sh
composer require google/cloud-error-reporting
```
-1. Create a [`php.ini`](php.ini) file in the root of your project and set
- `auto_prepend_file` to the following:
- ```ini
- ; in php.ini
- auto_prepend_file=/srv/vendor/google/cloud-error-reporting/src/prepend.php
+1. Add the command to autoload the "prepend.php" file at the beginning of every
+ request in `composer.json:
+ ```js
+ {
+ "autoload": {
+ "files": ["vendor/google/cloud-error-reporting/src/prepend.php"]
+ }
+ }
+
```
The [`prepend.php`][prepend] file will be executed prior to each request, which
@@ -22,8 +26,8 @@ registers the client library's error handler.
[prepend]: https://github.com/GoogleCloudPlatform/google-cloud-php-errorreporting/blob/main/src/prepend.php
-If you cannot modify your `php.ini`, the `prepend.php` file can be manually
-included to register the error handler:
+Alternatively, the `prepend.php` file can be manually included to register the
+error handler:
```php
# This works for files in the root of your project. Adjust __DIR__ accordingly.
@@ -56,8 +60,10 @@ in your browser. Browse to `/` to see a list of examples to execute.
### Run Locally
-Uncomment the `require_once` statement at the top of [`index.php`](index.php),
-or add the `auto_prepend_file` above to your local `php.ini`.
+The `prepend.php` file will be autoloaded on each request via composer. You
+can also uncomment the `require_once` statement at the top of
+[`index.php`](index.php), or load the file using `auto_prepend_file` in your
+local `php.ini`.
Now run the sample locally using PHP's build-in web server:
diff --git a/appengine/standard/errorreporting/app.yaml b/appengine/standard/errorreporting/app.yaml
index c29b1a9c97..47daeec88a 100644
--- a/appengine/standard/errorreporting/app.yaml
+++ b/appengine/standard/errorreporting/app.yaml
@@ -1,4 +1,4 @@
-runtime: php74
+runtime: php82
# Defaults to "serve index.php" and "serve public/index.php". Can be used to
# serve a custom PHP front controller (e.g. "serve backend/index.php") or to
diff --git a/appengine/standard/errorreporting/composer.json b/appengine/standard/errorreporting/composer.json
index 108185924f..3ae499d7ff 100644
--- a/appengine/standard/errorreporting/composer.json
+++ b/appengine/standard/errorreporting/composer.json
@@ -1,5 +1,10 @@
{
"require": {
- "google/cloud-error-reporting": "^0.19.0"
+ "google/cloud-error-reporting": "^0.20.0"
+ },
+ "autoload": {
+ "files": [
+ "vendor/google/cloud-error-reporting/src/prepend.php"
+ ]
}
}
diff --git a/appengine/standard/errorreporting/index.php b/appengine/standard/errorreporting/index.php
index 7ff1d0a8f4..181dbc131e 100644
--- a/appengine/standard/errorreporting/index.php
+++ b/appengine/standard/errorreporting/index.php
@@ -1,5 +1,8 @@
client->request('GET', '/');
$this->assertEquals('200', $resp->getStatusCode());
- $this->assertRegExp('/Visitor number: \d+/', (string) $resp->getBody());
+ $this->assertMatchesRegularExpression('/Visitor number: \d+/', (string) $resp->getBody());
}
public static function beforeDeploy()
diff --git a/appengine/standard/symfony-framework/app.yaml b/appengine/standard/symfony-framework/app.yaml
index a6720fa7d7..3e629bfb98 100644
--- a/appengine/standard/symfony-framework/app.yaml
+++ b/appengine/standard/symfony-framework/app.yaml
@@ -1,4 +1,4 @@
-runtime: php74
+runtime: php82
env_variables:
APP_ENV: prod
diff --git a/asset/src/export_assets.php b/asset/src/export_assets.php
index 86c91d6408..542a159c92 100644
--- a/asset/src/export_assets.php
+++ b/asset/src/export_assets.php
@@ -44,7 +44,7 @@ function export_assets(string $projectId, string $dumpFilePath)
print('The result is dumped to $dumpFilePath successfully.' . PHP_EOL);
} else {
$error = $resp->getError();
- printf('There was an error: "%s".' . PHP_EOL, $error->getMessage());
+ printf('There was an error: "%s".' . PHP_EOL, $error?->getMessage());
// handleError($error)
}
}
diff --git a/asset/test/assetSearchTest.php b/asset/test/assetSearchTest.php
index 6e9ea87e7b..c5db6e0ad0 100644
--- a/asset/test/assetSearchTest.php
+++ b/asset/test/assetSearchTest.php
@@ -19,16 +19,19 @@
use Google\Cloud\BigQuery\BigQueryClient;
use Google\Cloud\TestUtils\TestTrait;
-use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
use PHPUnit\Framework\TestCase;
+use PHPUnitRetry\RetryTrait;
/**
* Unit Tests for asset search commands.
+ *
+ * @retryAttempts 3
+ * @retryDelayMethod exponentialBackoff
*/
class assetSearchTest extends TestCase
{
+ use RetryTrait;
use TestTrait;
- use EventuallyConsistentTestTrait;
private static $datasetId;
private static $dataset;
@@ -52,13 +55,12 @@ public function testSearchAllResources()
$scope = 'projects/' . self::$projectId;
$query = 'name:' . self::$datasetId;
- $this->runEventuallyConsistentTest(function () use ($scope, $query) {
- $output = $this->runFunctionSnippet('search_all_resources', [
- $scope,
- $query
- ]);
- $this->assertStringContainsString(self::$datasetId, $output);
- }, 3, true);
+ $output = $this->runFunctionSnippet('search_all_resources', [
+ $scope,
+ $query
+ ]);
+
+ $this->assertStringContainsString(self::$datasetId, $output);
}
public function testSearchAllIamPolicies()
diff --git a/asset/test/assetTest.php b/asset/test/assetTest.php
index 18cf4eaad9..ae2b83a45d 100644
--- a/asset/test/assetTest.php
+++ b/asset/test/assetTest.php
@@ -19,16 +19,19 @@
use Google\Cloud\Storage\StorageClient;
use Google\Cloud\TestUtils\TestTrait;
-use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
use PHPUnit\Framework\TestCase;
+use PHPUnitRetry\RetryTrait;
/**
* Unit Tests for asset commands.
+ *
+ * @retryAttempts 3
+ * @retryDelayMethod exponentialBackoff
*/
class assetTest extends TestCase
{
+ use RetryTrait;
use TestTrait;
- use EventuallyConsistentTestTrait;
private static $storage;
private static $bucketName;
@@ -62,28 +65,24 @@ public function testExportAssets()
public function testListAssets()
{
$assetName = '//storage.googleapis.com/' . self::$bucketName;
- $this->runEventuallyConsistentTest(function () use ($assetName) {
- $output = $this->runFunctionSnippet('list_assets', [
- 'projectId' => self::$projectId,
- 'assetTypes' => ['storage.googleapis.com/Bucket'],
- 'pageSize' => 1000,
- ]);
+ $output = $this->runFunctionSnippet('list_assets', [
+ 'projectId' => self::$projectId,
+ 'assetTypes' => ['storage.googleapis.com/Bucket'],
+ 'pageSize' => 1000,
+ ]);
- $this->assertStringContainsString($assetName, $output);
- }, 10, true);
+ $this->assertStringContainsString($assetName, $output);
}
public function testBatchGetAssetsHistory()
{
$assetName = '//storage.googleapis.com/' . self::$bucketName;
- $this->runEventuallyConsistentTest(function () use ($assetName) {
- $output = $this->runFunctionSnippet('batch_get_assets_history', [
- 'projectId' => self::$projectId,
- 'assetNames' => [$assetName],
- ]);
+ $output = $this->runFunctionSnippet('batch_get_assets_history', [
+ 'projectId' => self::$projectId,
+ 'assetNames' => [$assetName],
+ ]);
- $this->assertStringContainsString($assetName, $output);
- }, 10, true);
+ $this->assertStringContainsString($assetName, $output);
}
}
diff --git a/auth/app.yaml b/auth/app.yaml
index 71d0ca74c7..3bf57985ac 100644
--- a/auth/app.yaml
+++ b/auth/app.yaml
@@ -1 +1 @@
-runtime: php72
+runtime: php82
diff --git a/bigtable/src/create_cluster.php b/bigtable/src/create_cluster.php
index 1836d0ecd2..d8e1dcb9da 100644
--- a/bigtable/src/create_cluster.php
+++ b/bigtable/src/create_cluster.php
@@ -92,7 +92,7 @@ function create_cluster(
printf('Cluster created: %s', $clusterId);
} else {
$error = $operationResponse->getError();
- printf('Cluster not created: %s', $error->getMessage());
+ printf('Cluster not created: %s', $error?->getMessage());
}
} else {
throw $e;
diff --git a/bigtable/src/create_cluster_autoscale_config.php b/bigtable/src/create_cluster_autoscale_config.php
index 54a6568dcb..a171c90c49 100644
--- a/bigtable/src/create_cluster_autoscale_config.php
+++ b/bigtable/src/create_cluster_autoscale_config.php
@@ -87,7 +87,7 @@ function create_cluster_autoscale_config(
printf('Cluster created: %s' . PHP_EOL, $clusterId);
} else {
$error = $operationResponse->getError();
- printf('Cluster not created: %s' . PHP_EOL, $error->getMessage());
+ printf('Cluster not created: %s' . PHP_EOL, $error?->getMessage());
}
}
// [END bigtable_api_cluster_create_autoscaling]
diff --git a/bigtable/src/disable_cluster_autoscale_config.php b/bigtable/src/disable_cluster_autoscale_config.php
index e1ef9bb170..0abfa13535 100644
--- a/bigtable/src/disable_cluster_autoscale_config.php
+++ b/bigtable/src/disable_cluster_autoscale_config.php
@@ -66,7 +66,7 @@ function disable_cluster_autoscale_config(
printf('Cluster updated with the new num of nodes: %s.' . PHP_EOL, $updatedCluster->getServeNodes());
} else {
$error = $operationResponse->getError();
- printf('Cluster %s failed to update: %s.' . PHP_EOL, $clusterId, $error->getMessage());
+ printf('Cluster %s failed to update: %s.' . PHP_EOL, $clusterId, $error?->getMessage());
}
} catch (ApiException $e) {
if ($e->getStatus() === 'NOT_FOUND') {
diff --git a/bigtable/src/update_cluster_autoscale_config.php b/bigtable/src/update_cluster_autoscale_config.php
index beea8f4ba2..2c5dab7007 100644
--- a/bigtable/src/update_cluster_autoscale_config.php
+++ b/bigtable/src/update_cluster_autoscale_config.php
@@ -83,7 +83,7 @@ function update_cluster_autoscale_config(
printf('Cluster %s updated with autoscale config.' . PHP_EOL, $clusterId);
} else {
$error = $operationResponse->getError();
- printf('Cluster %s failed to update: %s.' . PHP_EOL, $clusterId, $error->getMessage());
+ printf('Cluster %s failed to update: %s.' . PHP_EOL, $clusterId, $error?->getMessage());
}
} catch (ApiException $e) {
if ($e->getStatus() === 'NOT_FOUND') {
diff --git a/cloud_sql/mysql/pdo/app.standard.yaml b/cloud_sql/mysql/pdo/app.standard.yaml
index 0a1d3bae90..a705cd528b 100644
--- a/cloud_sql/mysql/pdo/app.standard.yaml
+++ b/cloud_sql/mysql/pdo/app.standard.yaml
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-runtime: php74
+runtime: php82
# Remember - storing secrets in plaintext is potentially unsafe. Consider using
# something like https://cloud.google.com/secret-manager/ to help keep secrets secret.
diff --git a/cloud_sql/mysql/pdo/test/IntegrationTest.php b/cloud_sql/mysql/pdo/test/IntegrationTest.php
index e7882fda8d..5c4df9c2d8 100644
--- a/cloud_sql/mysql/pdo/test/IntegrationTest.php
+++ b/cloud_sql/mysql/pdo/test/IntegrationTest.php
@@ -25,9 +25,6 @@
use Google\Cloud\TestUtils\CloudSqlProxyTrait;
use PHPUnit\Framework\TestCase;
-/**
- * @runTestsInSeparateProcesses
- */
class IntegrationTest extends TestCase
{
use TestTrait;
diff --git a/cloud_sql/mysql/pdo/test/VotesTest.php b/cloud_sql/mysql/pdo/test/VotesTest.php
index 209ec671b3..0d55a7bee2 100644
--- a/cloud_sql/mysql/pdo/test/VotesTest.php
+++ b/cloud_sql/mysql/pdo/test/VotesTest.php
@@ -23,10 +23,13 @@
use PDOStatement;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
use RuntimeException;
class VotesTest extends TestCase
{
+ use ProphecyTrait;
+
private $conn;
public function setUp(): void
diff --git a/cloud_sql/postgres/pdo/app.standard.yaml b/cloud_sql/postgres/pdo/app.standard.yaml
index 0a1d3bae90..a705cd528b 100644
--- a/cloud_sql/postgres/pdo/app.standard.yaml
+++ b/cloud_sql/postgres/pdo/app.standard.yaml
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-runtime: php74
+runtime: php82
# Remember - storing secrets in plaintext is potentially unsafe. Consider using
# something like https://cloud.google.com/secret-manager/ to help keep secrets secret.
diff --git a/cloud_sql/postgres/pdo/test/IntegrationTest.php b/cloud_sql/postgres/pdo/test/IntegrationTest.php
index 29fb10df8c..412ae03f43 100644
--- a/cloud_sql/postgres/pdo/test/IntegrationTest.php
+++ b/cloud_sql/postgres/pdo/test/IntegrationTest.php
@@ -25,9 +25,6 @@
use Google\Cloud\TestUtils\CloudSqlProxyTrait;
use PHPUnit\Framework\TestCase;
-/**
- * @runTestsInSeparateProcesses
- */
class IntegrationTest extends TestCase
{
use TestTrait;
diff --git a/cloud_sql/postgres/pdo/test/VotesTest.php b/cloud_sql/postgres/pdo/test/VotesTest.php
index 84fe6e4b5d..526f27bac3 100644
--- a/cloud_sql/postgres/pdo/test/VotesTest.php
+++ b/cloud_sql/postgres/pdo/test/VotesTest.php
@@ -23,10 +23,13 @@
use PDOStatement;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
use RuntimeException;
class VotesTest extends TestCase
{
+ use ProphecyTrait;
+
private $conn;
public function setUp(): void
diff --git a/cloud_sql/sqlserver/pdo/test/IntegrationTest.php b/cloud_sql/sqlserver/pdo/test/IntegrationTest.php
index 217f2ba782..be5dac072c 100644
--- a/cloud_sql/sqlserver/pdo/test/IntegrationTest.php
+++ b/cloud_sql/sqlserver/pdo/test/IntegrationTest.php
@@ -24,9 +24,6 @@
use Google\Cloud\TestUtils\CloudSqlProxyTrait;
use PHPUnit\Framework\TestCase;
-/**
- * @runTestsInSeparateProcesses
- */
class IntegrationTest extends TestCase
{
use TestTrait;
diff --git a/cloud_sql/sqlserver/pdo/test/VotesTest.php b/cloud_sql/sqlserver/pdo/test/VotesTest.php
index b9e3f7a1ac..9d0871abac 100644
--- a/cloud_sql/sqlserver/pdo/test/VotesTest.php
+++ b/cloud_sql/sqlserver/pdo/test/VotesTest.php
@@ -23,10 +23,13 @@
use PDOStatement;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
use RuntimeException;
class VotesTest extends TestCase
{
+ use ProphecyTrait;
+
private $conn;
public function setUp(): void
diff --git a/compute/firewall/src/create_firewall_rule.php b/compute/firewall/src/create_firewall_rule.php
index daea3ddc3b..fe008d6656 100644
--- a/compute/firewall/src/create_firewall_rule.php
+++ b/compute/firewall/src/create_firewall_rule.php
@@ -82,7 +82,7 @@ function create_firewall_rule(string $projectId, string $firewallRuleName, strin
printf('Created rule %s.' . PHP_EOL, $firewallRuleName);
} else {
$error = $operation->getError();
- printf('Firewall rule creation failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Firewall rule creation failed: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_firewall_create]
diff --git a/compute/firewall/src/delete_firewall_rule.php b/compute/firewall/src/delete_firewall_rule.php
index fe9fea8a4a..adc15189a1 100644
--- a/compute/firewall/src/delete_firewall_rule.php
+++ b/compute/firewall/src/delete_firewall_rule.php
@@ -48,7 +48,7 @@ function delete_firewall_rule(string $projectId, string $firewallRuleName)
printf('Rule %s deleted successfully!' . PHP_EOL, $firewallRuleName);
} else {
$error = $operation->getError();
- printf('Failed to delete firewall rule: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to delete firewall rule: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_firewall_delete]
diff --git a/compute/firewall/src/patch_firewall_priority.php b/compute/firewall/src/patch_firewall_priority.php
index a024ed55a3..32ad00197c 100644
--- a/compute/firewall/src/patch_firewall_priority.php
+++ b/compute/firewall/src/patch_firewall_priority.php
@@ -52,7 +52,7 @@ function patch_firewall_priority(string $projectId, string $firewallRuleName, in
printf('Patched %s priority to %d.' . PHP_EOL, $firewallRuleName, $priority);
} else {
$error = $operation->getError();
- printf('Patching failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Patching failed: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_firewall_patch]
diff --git a/compute/instances/src/create_instance.php b/compute/instances/src/create_instance.php
index 2a6675891b..9ba9f9b1e8 100644
--- a/compute/instances/src/create_instance.php
+++ b/compute/instances/src/create_instance.php
@@ -91,7 +91,7 @@ function create_instance(
printf('Created instance %s' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Instance creation failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Instance creation failed: %s' . PHP_EOL, $error?->getMessage());
}
# [END compute_instances_operation_check]
}
diff --git a/compute/instances/src/create_instance_with_encryption_key.php b/compute/instances/src/create_instance_with_encryption_key.php
index 8e84d6a97b..a40ad10458 100644
--- a/compute/instances/src/create_instance_with_encryption_key.php
+++ b/compute/instances/src/create_instance_with_encryption_key.php
@@ -102,7 +102,7 @@ function create_instance_with_encryption_key(
printf('Created instance %s' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Instance creation failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Instance creation failed: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_instances_create_encrypted]
diff --git a/compute/instances/src/delete_instance.php b/compute/instances/src/delete_instance.php
index 12a62a667f..79a916c9c0 100644
--- a/compute/instances/src/delete_instance.php
+++ b/compute/instances/src/delete_instance.php
@@ -51,7 +51,7 @@ function delete_instance(
printf('Deleted instance %s' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to delete instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to delete instance: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_instances_delete]
diff --git a/compute/instances/src/disable_usage_export_bucket.php b/compute/instances/src/disable_usage_export_bucket.php
index 4e9bc75815..f5ba386aca 100644
--- a/compute/instances/src/disable_usage_export_bucket.php
+++ b/compute/instances/src/disable_usage_export_bucket.php
@@ -46,7 +46,7 @@ function disable_usage_export_bucket(string $projectId)
printf('Compute Engine usage export bucket for project `%s` was disabled.', $projectId);
} else {
$error = $operation->getError();
- printf('Failed to disable usage report bucket for project `%s`: %s' . PHP_EOL, $projectId, $error->getMessage());
+ printf('Failed to disable usage report bucket for project `%s`: %s' . PHP_EOL, $projectId, $error?->getMessage());
}
}
# [END compute_usage_report_disable]
diff --git a/compute/instances/src/reset_instance.php b/compute/instances/src/reset_instance.php
index 2b0a797c58..9c8ecb7c98 100644
--- a/compute/instances/src/reset_instance.php
+++ b/compute/instances/src/reset_instance.php
@@ -51,7 +51,7 @@ function reset_instance(
printf('Instance %s reset successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to reset instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to reset instance: %s' . PHP_EOL, $error?->getMessage());
}
}
diff --git a/compute/instances/src/resume_instance.php b/compute/instances/src/resume_instance.php
index 196fa60ce6..2842c75c5d 100644
--- a/compute/instances/src/resume_instance.php
+++ b/compute/instances/src/resume_instance.php
@@ -51,7 +51,7 @@ function resume_instance(
printf('Instance %s resumed successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to resume instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to resume instance: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_resume_instance]
diff --git a/compute/instances/src/set_usage_export_bucket.php b/compute/instances/src/set_usage_export_bucket.php
index 688d8994e4..5d44edea17 100644
--- a/compute/instances/src/set_usage_export_bucket.php
+++ b/compute/instances/src/set_usage_export_bucket.php
@@ -76,7 +76,7 @@ function set_usage_export_bucket(
);
} else {
$error = $operation->getError();
- printf('Setting usage export bucket failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Setting usage export bucket failed: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_usage_report_set]
diff --git a/compute/instances/src/start_instance.php b/compute/instances/src/start_instance.php
index bad757cfd6..94b1c0dcfa 100644
--- a/compute/instances/src/start_instance.php
+++ b/compute/instances/src/start_instance.php
@@ -51,7 +51,7 @@ function start_instance(
printf('Instance %s started successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to start instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to start instance: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_start_instance]
diff --git a/compute/instances/src/start_instance_with_encryption_key.php b/compute/instances/src/start_instance_with_encryption_key.php
index ca0023b1a6..95a7e4ae03 100644
--- a/compute/instances/src/start_instance_with_encryption_key.php
+++ b/compute/instances/src/start_instance_with_encryption_key.php
@@ -77,7 +77,7 @@ function start_instance_with_encryption_key(
printf('Instance %s started successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Starting instance failed: %s' . PHP_EOL, $error->getMessage());
+ printf('Starting instance failed: %s' . PHP_EOL, $error?->getMessage());
}
}
# [END compute_start_enc_instance]
diff --git a/compute/instances/src/stop_instance.php b/compute/instances/src/stop_instance.php
index b77d0dc90e..718f41e51a 100644
--- a/compute/instances/src/stop_instance.php
+++ b/compute/instances/src/stop_instance.php
@@ -51,7 +51,7 @@ function stop_instance(
printf('Instance %s stopped successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to stop instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to stop instance: %s' . PHP_EOL, $error?->getMessage());
}
}
diff --git a/compute/instances/src/suspend_instance.php b/compute/instances/src/suspend_instance.php
index 8c1a14b6a6..1a94848dd2 100644
--- a/compute/instances/src/suspend_instance.php
+++ b/compute/instances/src/suspend_instance.php
@@ -51,7 +51,7 @@ function suspend_instance(
printf('Instance %s suspended successfully' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
- printf('Failed to suspend instance: %s' . PHP_EOL, $error->getMessage());
+ printf('Failed to suspend instance: %s' . PHP_EOL, $error?->getMessage());
}
}
diff --git a/compute/instances/test/instancesTest.php b/compute/instances/test/instancesTest.php
index 29d7258274..611c0234d7 100644
--- a/compute/instances/test/instancesTest.php
+++ b/compute/instances/test/instancesTest.php
@@ -20,9 +20,15 @@
use Google\Cloud\Storage\StorageClient;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
+use PHPUnitRetry\RetryTrait;
+/**
+ * @retryAttempts 3
+ * @retryDelayMethod exponentialBackoff
+ */
class instancesTest extends TestCase
{
+ use RetryTrait;
use TestTrait;
private static $instanceName;
diff --git a/dlp/README.md b/dlp/README.md
index 6d19e752da..b7e1e59abd 100644
--- a/dlp/README.md
+++ b/dlp/README.md
@@ -58,7 +58,7 @@ PHP Fatal error: Uncaught Error: Call to undefined function Google\Protobuf\Int
You may need to install the bcmath PHP extension.
e.g. (may depend on your php version)
```
-$ sudo apt-get install php7.3-bcmath
+$ sudo apt-get install php8.0-bcmath
```
diff --git a/dlp/test/dlpLongRunningTest.php b/dlp/test/dlpLongRunningTest.php
index b453a32af4..b2491b3a09 100644
--- a/dlp/test/dlpLongRunningTest.php
+++ b/dlp/test/dlpLongRunningTest.php
@@ -107,8 +107,8 @@ public function testNumericalStats()
$columnName,
]);
- $this->assertRegExp('/Value range: \[\d+, \d+\]/', $output);
- $this->assertRegExp('/Value at \d+ quantile: \d+/', $output);
+ $this->assertMatchesRegularExpression('/Value range: \[\d+, \d+\]/', $output);
+ $this->assertMatchesRegularExpression('/Value at \d+ quantile: \d+/', $output);
}
public function testCategoricalStats()
@@ -125,9 +125,9 @@ public function testCategoricalStats()
$columnName,
]);
- $this->assertRegExp('/Most common value occurs \d+ time\(s\)/', $output);
- $this->assertRegExp('/Least common value occurs \d+ time\(s\)/', $output);
- $this->assertRegExp('/\d+ unique value\(s\) total/', $output);
+ $this->assertMatchesRegularExpression('/Most common value occurs \d+ time\(s\)/', $output);
+ $this->assertMatchesRegularExpression('/Least common value occurs \d+ time\(s\)/', $output);
+ $this->assertMatchesRegularExpression('/\d+ unique value\(s\) total/', $output);
}
public function testKAnonymity()
@@ -144,7 +144,7 @@ public function testKAnonymity()
$quasiIds,
]);
$this->assertStringContainsString('{"stringValue":"Female"}', $output);
- $this->assertRegExp('/Class size: \d/', $output);
+ $this->assertMatchesRegularExpression('/Class size: \d/', $output);
}
public function testLDiversity()
@@ -163,7 +163,7 @@ public function testLDiversity()
$quasiIds,
]);
$this->assertStringContainsString('{"stringValue":"Female"}', $output);
- $this->assertRegExp('/Class size: \d/', $output);
+ $this->assertMatchesRegularExpression('/Class size: \d/', $output);
$this->assertStringContainsString('{"stringValue":"James"}', $output);
}
@@ -184,8 +184,8 @@ public function testKMap()
$quasiIds,
$infoTypes,
]);
- $this->assertRegExp('/Anonymity range: \[\d, \d\]/', $output);
- $this->assertRegExp('/Size: \d/', $output);
+ $this->assertMatchesRegularExpression('/Anonymity range: \[\d, \d\]/', $output);
+ $this->assertMatchesRegularExpression('/Size: \d/', $output);
$this->assertStringContainsString('{"stringValue":"Female"}', $output);
}
}
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index fa051e536b..54358fe795 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -153,7 +153,7 @@ public function testDeidReidFPE()
$wrappedKey,
$surrogateType,
]);
- $this->assertRegExp('/My SSN is SSN_TOKEN\(9\):\d+/', $deidOutput);
+ $this->assertMatchesRegularExpression('/My SSN is SSN_TOKEN\(9\):\d+/', $deidOutput);
$reidOutput = $this->runFunctionSnippet('reidentify_fpe', [
self::$projectId,
@@ -248,7 +248,7 @@ public function testJobs()
$filter,
]);
- $this->assertRegExp($jobIdRegex, $output);
+ $this->assertMatchesRegularExpression($jobIdRegex, $output);
preg_match($jobIdRegex, $output, $jobIds);
$jobId = $jobIds[0];
diff --git a/language/test/quickstartTest.php b/language/test/quickstartTest.php
index 969b94f004..4e50c91f89 100644
--- a/language/test/quickstartTest.php
+++ b/language/test/quickstartTest.php
@@ -36,8 +36,8 @@ public function testQuickstart()
// Invoke quickstart.php
$output = $this->runSnippet($file);
- $this->assertRegExp('/Text: Hello, world!/', $output);
- $this->assertRegExp($p = '/Sentiment: (\\d.\\d+), (\\d.\\d+)/', $output);
+ $this->assertMatchesRegularExpression('/Text: Hello, world!/', $output);
+ $this->assertMatchesRegularExpression($p = '/Sentiment: (\\d.\\d+), (\\d.\\d+)/', $output);
// Make sure it looks correct
preg_match($p, $output, $matches);
diff --git a/logging/test/loggingTest.php b/logging/test/loggingTest.php
index 66245cad53..270f69ebd7 100644
--- a/logging/test/loggingTest.php
+++ b/logging/test/loggingTest.php
@@ -91,7 +91,7 @@ public function testUpdateSink()
$logging = new LoggingClient(['projectId' => self::$projectId]);
$sink = $logging->sink(self::$sinkName);
$sink->reload();
- $this->assertRegExp(
+ $this->assertMatchesRegularExpression(
sprintf(
'|projects/%s/logs/%s|',
self::$projectId,
@@ -119,7 +119,7 @@ public function testUpdateSinkWithFilter()
$logging = new LoggingClient(['projectId' => self::$projectId]);
$sink = $logging->sink(self::$sinkName);
$sink->reload();
- $this->assertRegExp('/severity >= INFO/', $sink->info()['filter']);
+ $this->assertMatchesRegularExpression('/severity >= INFO/', $sink->info()['filter']);
}
/**
diff --git a/media/transcoder/test/transcoderTest.php b/media/transcoder/test/transcoderTest.php
index ad460caa9b..039858fcd4 100644
--- a/media/transcoder/test/transcoderTest.php
+++ b/media/transcoder/test/transcoderTest.php
@@ -167,7 +167,7 @@ public function testJobFromAdHoc()
self::$inputVideoUri,
self::$outputUriForAdHoc
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $createOutput);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $createOutput);
$jobId = explode('/', $createOutput);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -209,7 +209,7 @@ public function testJobFromPreset()
self::$preset
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -241,7 +241,7 @@ public function testJobFromTemplate()
$jobTemplateId
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -272,7 +272,7 @@ public function testJobAnimatedOverlay()
self::$outputUriForAnimatedOverlay
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -297,7 +297,7 @@ public function testJobStaticOverlay()
self::$outputUriForStaticOverlay
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -321,7 +321,7 @@ public function testJobPeriodicImagesSpritesheet()
self::$outputUriForPeriodicImagesSpritesheet
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -345,7 +345,7 @@ public function testJobSetNumberImagesSpritesheet()
self::$outputUriForSetNumberImagesSpritesheet
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
@@ -374,7 +374,7 @@ public function testJobConcat()
self::$outputUriForConcat
]);
- $this->assertRegExp(sprintf('%s', self::$jobIdRegex), $output);
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
diff --git a/pubsub/api/test/pubsubTest.php b/pubsub/api/test/pubsubTest.php
index 98c792ed66..2f4dcb72ee 100644
--- a/pubsub/api/test/pubsubTest.php
+++ b/pubsub/api/test/pubsubTest.php
@@ -133,7 +133,7 @@ public function testListTopics()
$output = $this->runFunctionSnippet('list_topics', [
self::$projectId,
]);
- $this->assertRegExp(sprintf('/%s/', $topic), $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
}
public function testCreateAndDeleteTopic()
@@ -144,16 +144,16 @@ public function testCreateAndDeleteTopic()
$topic,
]);
- $this->assertRegExp('/Topic created:/', $output);
- $this->assertRegExp(sprintf('/%s/', $topic), $output);
+ $this->assertMatchesRegularExpression('/Topic created:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
$output = $this->runFunctionSnippet('delete_topic', [
self::$projectId,
$topic,
]);
- $this->assertRegExp('/Topic deleted:/', $output);
- $this->assertRegExp(sprintf('/%s/', $topic), $output);
+ $this->assertMatchesRegularExpression('/Topic deleted:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
}
public function testTopicMessage()
@@ -166,7 +166,7 @@ public function testTopicMessage()
'This is a test message',
]);
- $this->assertRegExp('/Message published/', $output);
+ $this->assertMatchesRegularExpression('/Message published/', $output);
}
public function testTopicMessageWithRetrySettings()
@@ -179,7 +179,7 @@ public function testTopicMessageWithRetrySettings()
'This is a test message',
]);
- $this->assertRegExp('/Message published with retry settings/', $output);
+ $this->assertMatchesRegularExpression('/Message published with retry settings/', $output);
}
public function testListSubscriptions()
@@ -190,7 +190,7 @@ public function testListSubscriptions()
self::$projectId,
]);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
}
public function testCreateAndDeleteSubscription()
@@ -203,16 +203,16 @@ public function testCreateAndDeleteSubscription()
$subscription,
]);
- $this->assertRegExp('/Subscription created:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription created:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
$output = $this->runFunctionSnippet('delete_subscription', [
self::$projectId,
$subscription,
]);
- $this->assertRegExp('/Subscription deleted:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription deleted:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
}
public function testCreateAndDeleteSubscriptionWithFilter()
@@ -271,16 +271,16 @@ public function testCreateAndDeletePushSubscription()
$fakeUrl,
]);
- $this->assertRegExp('/Subscription created:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription created:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
$output = $this->runFunctionSnippet('delete_subscription', [
self::$projectId,
$subscription,
]);
- $this->assertRegExp('/Subscription deleted:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription deleted:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
}
public function testCreateAndDeleteBigQuerySubscription()
@@ -297,16 +297,16 @@ public function testCreateAndDeleteBigQuerySubscription()
$table,
]);
- $this->assertRegExp('/Subscription created:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription created:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
$output = $this->runFunctionSnippet('delete_subscription', [
self::$projectId,
$subscription,
]);
- $this->assertRegExp('/Subscription deleted:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription deleted:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
}
public function testCreateAndDetachSubscription()
@@ -319,16 +319,16 @@ public function testCreateAndDetachSubscription()
$subscription,
]);
- $this->assertRegExp('/Subscription created:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription created:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
$output = $this->runFunctionSnippet('detach_subscription', [
self::$projectId,
$subscription,
]);
- $this->assertRegExp('/Subscription detached:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription detached:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
// delete test resource
$output = $this->runFunctionSnippet('delete_subscription', [
@@ -336,8 +336,8 @@ public function testCreateAndDetachSubscription()
$subscription,
]);
- $this->assertRegExp('/Subscription deleted:/', $output);
- $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+ $this->assertMatchesRegularExpression('/Subscription deleted:/', $output);
+ $this->assertMatchesRegularExpression(sprintf('/%s/', $subscription), $output);
}
public function testPullMessages()
@@ -351,14 +351,14 @@ public function testPullMessages()
'This is a test message',
]);
- $this->assertRegExp('/Message published/', $output);
+ $this->assertMatchesRegularExpression('/Message published/', $output);
$this->runEventuallyConsistentTest(function () use ($subscription) {
$output = $this->runFunctionSnippet('pull_messages', [
self::$projectId,
$subscription,
]);
- $this->assertRegExp('/This is a test message/', $output);
+ $this->assertMatchesRegularExpression('/This is a test message/', $output);
});
}
@@ -379,7 +379,7 @@ public function testPullMessagesBatchPublisher()
$messageData,
]);
- $this->assertRegExp('/Messages enqueued for publication/', $output);
+ $this->assertMatchesRegularExpression('/Messages enqueued for publication/', $output);
$this->runEventuallyConsistentTest(function () use ($subscription, $messageData) {
$output = $this->runFunctionSnippet('pull_messages', [
@@ -421,7 +421,7 @@ public function testSubscribeExactlyOnceDelivery()
// There should be at least one acked message
// pulled from the subscription.
- $this->assertRegExp('/Acknowledged message:/', $output);
+ $this->assertMatchesRegularExpression('/Acknowledged message:/', $output);
});
}
}
diff --git a/servicedirectory/README.md b/servicedirectory/README.md
index 39e184619c..1762476091 100644
--- a/servicedirectory/README.md
+++ b/servicedirectory/README.md
@@ -55,7 +55,7 @@ PHP Fatal error: Uncaught Error: Call to undefined function Google\Protobuf\Int
You may need to install the bcmath PHP extension.
e.g. (may depend on your php version)
```
-$ sudo apt-get install php7.3-bcmath
+$ sudo apt-get install php8.0-bcmath
```
diff --git a/spanner/test/spannerBackupTest.php b/spanner/test/spannerBackupTest.php
index 1d6535f749..b98297aed7 100644
--- a/spanner/test/spannerBackupTest.php
+++ b/spanner/test/spannerBackupTest.php
@@ -180,7 +180,7 @@ public function testCopyBackup()
]);
$regex = '/Backup %s of size \d+ bytes was copied at (.+) from the source backup %s/';
- $this->assertRegExp(sprintf($regex, $newBackupId, self::$backupId), $output);
+ $this->assertMatchesRegularExpression(sprintf($regex, $newBackupId, self::$backupId), $output);
}
/**
diff --git a/storage/test/storageTest.php b/storage/test/storageTest.php
index e824641ad5..1b5a87f6c1 100644
--- a/storage/test/storageTest.php
+++ b/storage/test/storageTest.php
@@ -59,7 +59,7 @@ public function testBucketAcl()
self::$tempBucket->name(),
]);
- $this->assertRegExp('/: OWNER/', $output);
+ $this->assertMatchesRegularExpression('/: OWNER/', $output);
}
public function testPrintDefaultBucketAcl()
diff --git a/storagetransfer/test/StorageTransferTest.php b/storagetransfer/test/StorageTransferTest.php
index 2da43968e4..e31a206b2d 100644
--- a/storagetransfer/test/StorageTransferTest.php
+++ b/storagetransfer/test/StorageTransferTest.php
@@ -62,7 +62,7 @@ public function testQuickstart()
self::$projectId, self::$sinkBucket->name(), self::$sourceBucket->name()
]);
- $this->assertRegExp('/transferJobs\/.*/', $output);
+ $this->assertMatchesRegularExpression('/transferJobs\/.*/', $output);
preg_match('/transferJobs\/\d+/', $output, $match);
$jobName = $match[0];
diff --git a/testing/composer.json b/testing/composer.json
index 29453b6755..88e64eb382 100755
--- a/testing/composer.json
+++ b/testing/composer.json
@@ -1,14 +1,15 @@
{
"require": {
- "php": "^7.2|^7.3|^7.4|^8.0"
+ "php": "^8.0"
},
"require-dev": {
"bshaffer/phpunit-retry-annotations": "^0.3.0",
"google/auth": "^1.12",
"google/cloud-tools": "dev-main",
"guzzlehttp/guzzle": "^7.0",
- "phpunit/phpunit": "^7|^8,<8.5.27",
+ "phpunit/phpunit": "^9.0",
"friendsofphp/php-cs-fixer": "^3,<3.9",
- "composer/semver": "^3.2"
+ "composer/semver": "^3.2",
+ "phpspec/prophecy-phpunit": "^2.0"
}
}
From 2fe847da350d37f2f3c8d1817c61d939321079d1 Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Fri, 19 May 2023 15:11:08 +0200
Subject: [PATCH 026/285] fix(deps): update dependency guzzlehttp/guzzle to
~7.6.0 (#1846)
---
iap/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/iap/composer.json b/iap/composer.json
index 614dc9342a..9c3f1eb133 100644
--- a/iap/composer.json
+++ b/iap/composer.json
@@ -2,7 +2,7 @@
"require": {
"kelvinmo/simplejwt": "^0.5.1",
"google/auth":"^1.8.0",
- "guzzlehttp/guzzle": "~7.5.0"
+ "guzzlehttp/guzzle": "~7.6.0"
},
"autoload": {
"psr-4": {
From 1abdd682f41c5d16ee614a3cd98cbe5840a983ca Mon Sep 17 00:00:00 2001
From: Ajumal
Date: Mon, 22 May 2023 10:34:05 +0530
Subject: [PATCH 027/285] feat(Pubsub): Add samples for ordering keys (#1811)
---
.../api/src/enable_subscription_ordering.php | 51 ++++++++++++++++++
pubsub/api/src/publish_with_ordering_keys.php | 52 +++++++++++++++++++
pubsub/api/test/pubsubTest.php | 19 +++++++
3 files changed, 122 insertions(+)
create mode 100644 pubsub/api/src/enable_subscription_ordering.php
create mode 100644 pubsub/api/src/publish_with_ordering_keys.php
diff --git a/pubsub/api/src/enable_subscription_ordering.php b/pubsub/api/src/enable_subscription_ordering.php
new file mode 100644
index 0000000000..4b6dfde3a4
--- /dev/null
+++ b/pubsub/api/src/enable_subscription_ordering.php
@@ -0,0 +1,51 @@
+ $projectId,
+ ]);
+ $topic = $pubsub->topic($topicName);
+ $subscription = $topic->subscription($subscriptionName);
+
+ $subscription->create(['enableMessageOrdering' => true]);
+
+ printf('Created subscription with ordering: %s' . PHP_EOL, $subscription->name());
+ printf('Subscription info: %s' . PHP_EOL, json_encode($subscription->info()));
+}
+# [END pubsub_enable_subscription_ordering]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/src/publish_with_ordering_keys.php b/pubsub/api/src/publish_with_ordering_keys.php
new file mode 100644
index 0000000000..ea71a8e97e
--- /dev/null
+++ b/pubsub/api/src/publish_with_ordering_keys.php
@@ -0,0 +1,52 @@
+ $projectId,
+ ]);
+
+ $topic = $pubsub->topic($topicName);
+ foreach (range(1, 5) as $i) {
+ $topic->publish((new MessageBuilder(['orderingKey' => 'foo']))
+ ->setData('message' . $i)->build(), ['enableMessageOrdering' => true]);
+ }
+
+ print('Message published' . PHP_EOL);
+}
+# [END pubsub_publish_with_ordering_keys]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/test/pubsubTest.php b/pubsub/api/test/pubsubTest.php
index 2f4dcb72ee..4143db5c64 100644
--- a/pubsub/api/test/pubsubTest.php
+++ b/pubsub/api/test/pubsubTest.php
@@ -424,4 +424,23 @@ public function testSubscribeExactlyOnceDelivery()
$this->assertMatchesRegularExpression('/Acknowledged message:/', $output);
});
}
+
+ public function testPublishAndSubscribeWithOrderingKeys()
+ {
+ $topic = $this->requireEnv('GOOGLE_PUBSUB_TOPIC');
+
+ $output = $this->runFunctionSnippet('publish_with_ordering_keys', [
+ self::$projectId,
+ $topic,
+ ]);
+ $this->assertRegExp('/Message published/', $output);
+
+ $output = $this->runFunctionSnippet('enable_subscription_ordering', [
+ self::$projectId,
+ $topic,
+ 'subscriberWithOrdering' . rand(),
+ ]);
+ $this->assertRegExp('/Created subscription with ordering/', $output);
+ $this->assertRegExp('/\"enableMessageOrdering\":true/', $output);
+ }
}
From ec73ad1877ca0d8e9356a737fc353babd6c73fb6 Mon Sep 17 00:00:00 2001
From: Yash Sahu <54198301+yash30201@users.noreply.github.com>
Date: Wed, 24 May 2023 15:31:39 +0530
Subject: [PATCH 028/285] feat(PubSub): Added Samples (#1845)
Added samples to commit, list and get revision schemas
---
pubsub/api/src/commit_avro_schema.php | 57 +++++++++++++++++++++++
pubsub/api/src/commit_proto_schema.php | 58 ++++++++++++++++++++++++
pubsub/api/src/get_schema_revision.php | 53 ++++++++++++++++++++++
pubsub/api/src/list_schema_revisions.php | 54 ++++++++++++++++++++++
pubsub/api/test/SchemaTest.php | 57 +++++++++++++++++++++++
5 files changed, 279 insertions(+)
create mode 100644 pubsub/api/src/commit_avro_schema.php
create mode 100644 pubsub/api/src/commit_proto_schema.php
create mode 100644 pubsub/api/src/get_schema_revision.php
create mode 100644 pubsub/api/src/list_schema_revisions.php
diff --git a/pubsub/api/src/commit_avro_schema.php b/pubsub/api/src/commit_avro_schema.php
new file mode 100644
index 0000000000..e92e8f0ae2
--- /dev/null
+++ b/pubsub/api/src/commit_avro_schema.php
@@ -0,0 +1,57 @@
+schemaName($projectId, $schemaId);
+ try {
+ $schema = new Schema();
+ $definition = file_get_contents($avscFile);
+ $schema->setName($schemaName)
+ ->setType(Type::AVRO)
+ ->setDefinition($definition);
+ $response = $client->commitSchema($schemaName, $schema);
+ printf("Committed a schema using an Avro schema: %s\n", $response->getName());
+ } catch (ApiException $e) {
+ printf("%s does not exist.\n", $schemaName);
+ }
+}
+# [END pubsub_commit_avro_schema]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/src/commit_proto_schema.php b/pubsub/api/src/commit_proto_schema.php
new file mode 100644
index 0000000000..6bc1b8a70f
--- /dev/null
+++ b/pubsub/api/src/commit_proto_schema.php
@@ -0,0 +1,58 @@
+schemaName($projectId, $schemaId);
+ try {
+ $schema = new Schema();
+ $definition = file_get_contents($protoFile);
+ $schema->setName($schemaName)
+ ->setType(Type::PROTOCOL_BUFFER)
+ ->setDefinition($definition);
+ $response = $client->commitSchema($schemaName, $schema);
+ printf("Committed a schema using an Proto schema: %s\n", $response->getName());
+ } catch (ApiException $e) {
+ printf("%s does not exist.\n", $schemaName);
+ }
+}
+# [END pubsub_commit_proto_schema]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/src/get_schema_revision.php b/pubsub/api/src/get_schema_revision.php
new file mode 100644
index 0000000000..87b3ca4e92
--- /dev/null
+++ b/pubsub/api/src/get_schema_revision.php
@@ -0,0 +1,53 @@
+schemaName(
+ $projectId, $schemaId . '@' . $schemaRevisionId
+ );
+
+ try {
+ $response = $schemaServiceClient->getSchema($schemaName);
+ printf('Got a schema revision: %s' . PHP_EOL, $response->getName());
+ } catch (ApiException $ex) {
+ printf('%s not found' . PHP_EOL, $schemaName);
+ }
+}
+# [END pubsub_get_schema_revision]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/src/list_schema_revisions.php b/pubsub/api/src/list_schema_revisions.php
new file mode 100644
index 0000000000..9b68c8c26e
--- /dev/null
+++ b/pubsub/api/src/list_schema_revisions.php
@@ -0,0 +1,54 @@
+schemaName($projectId, $schemaId);
+
+ try {
+ $responses = $schemaServiceClient->listSchemaRevisions($schemaName);
+ foreach ($responses as $response) {
+ printf('Got a schema revision: %s' . PHP_EOL, $response->getName());
+ }
+ printf('Listed schema revisions.' . PHP_EOL);
+ } catch (ApiException $ex) {
+ printf('%s not found' . PHP_EOL, $schemaName);
+ }
+}
+# [END pubsub_list_schema_revisions]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/pubsub/api/test/SchemaTest.php b/pubsub/api/test/SchemaTest.php
index c7ea7bd686..8868aaffce 100644
--- a/pubsub/api/test/SchemaTest.php
+++ b/pubsub/api/test/SchemaTest.php
@@ -88,6 +88,63 @@ public function testCreateGetListAndDelete($type, $definitionFile)
);
}
+ /**
+ * @dataProvider definitions
+ */
+ public function testSchemaRevision($type, $definitionFile)
+ {
+ $schemaId = uniqid('samples-test-' . $type . '-');
+ $schemaName = SchemaServiceClient::schemaName(self::$projectId, $schemaId);
+
+ $this->runFunctionSnippet(sprintf('create_%s_schema', $type), [
+ self::$projectId,
+ $schemaId,
+ $definitionFile,
+ ]);
+
+ $listOutput = $this->runFunctionSnippet(sprintf('commit_%s_schema', $type), [
+ self::$projectId,
+ $schemaId,
+ $definitionFile,
+ ]);
+
+ $this->assertStringContainsString(
+ sprintf(
+ 'Committed a schema using an %s schema: %s@', ucfirst($type), $schemaName
+ ),
+ $listOutput
+ );
+
+ $schemaRevisionId = trim(explode('@', $listOutput)[1]);
+
+ $listOutput = $this->runFunctionSnippet('get_schema_revision', [
+ self::$projectId,
+ $schemaId,
+ $schemaRevisionId,
+ ]);
+
+ $this->assertStringContainsString(
+ sprintf(
+ 'Got a schema revision: %s@%s',
+ $schemaName,
+ $schemaRevisionId
+ ),
+ $listOutput
+ );
+
+ $listOutput = $this->runFunctionSnippet('list_schema_revisions', [
+ self::$projectId,
+ $schemaId
+ ]);
+
+ $this->assertStringContainsString('Listed schema revisions', $listOutput);
+
+ $this->runFunctionSnippet('delete_schema', [
+ self::$projectId,
+ $schemaId,
+ ]);
+ }
+
/**
* @dataProvider definitions
*/
From ce7b3d20a90832c4a3758cb8cc33d4bc98559941 Mon Sep 17 00:00:00 2001
From: Drew Brown
Date: Wed, 24 May 2023 14:07:03 -0700
Subject: [PATCH 029/285] chore(endpoints): Update region tag with product
prefix (#1850)
---
endpoints/getting-started/app.yaml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/endpoints/getting-started/app.yaml b/endpoints/getting-started/app.yaml
index 127fba4670..8ca55d6563 100644
--- a/endpoints/getting-started/app.yaml
+++ b/endpoints/getting-started/app.yaml
@@ -4,7 +4,7 @@ env: flex
runtime_config:
document_root: .
-# [START configuration]
+# [START endpoints_configuration]
endpoints_api_service:
# The following values are to be replaced by information from the output of
# 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
@@ -15,4 +15,4 @@ endpoints_api_service:
#
name: ENDPOINTS-SERVICE-NAME
rollout_strategy: managed
-# [END configuration]
+# [END endpoints_configuration]
From 91ea495a541c139c1b9f1c81e2e33374ddd11c95 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Fri, 26 May 2023 00:21:59 +0530
Subject: [PATCH 030/285] feat(dlp): inspect info types samples (#1849)
---
dlp/src/inspect_augment_infotypes.php | 110 ++++++++++++++
...nspect_column_values_w_custom_hotwords.php | 138 ++++++++++++++++++
dlp/src/inspect_image_all_infotypes.php | 85 +++++++++++
dlp/src/inspect_image_listed_infotypes.php | 96 ++++++++++++
dlp/src/inspect_table.php | 101 +++++++++++++
dlp/test/dlpTest.php | 69 +++++++++
6 files changed, 599 insertions(+)
create mode 100644 dlp/src/inspect_augment_infotypes.php
create mode 100644 dlp/src/inspect_column_values_w_custom_hotwords.php
create mode 100644 dlp/src/inspect_image_all_infotypes.php
create mode 100644 dlp/src/inspect_image_listed_infotypes.php
create mode 100644 dlp/src/inspect_table.php
diff --git a/dlp/src/inspect_augment_infotypes.php b/dlp/src/inspect_augment_infotypes.php
new file mode 100644
index 0000000000..893ea71f48
--- /dev/null
+++ b/dlp/src/inspect_augment_infotypes.php
@@ -0,0 +1,110 @@
+setValue($textToInspect);
+
+ // The infoTypes of information to match.
+ $personNameInfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+
+ // Construct the word list to be detected.
+ $wordList = (new Dictionary())
+ ->setWordList((new WordList())
+ ->setWords($matchWordList));
+
+ // Construct the custom infotype detector.
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($personNameInfoType)
+ ->setLikelihood(Likelihood::POSSIBLE)
+ ->setDictionary($wordList);
+
+ // Construct the configuration for the Inspect request.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_augment_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_column_values_w_custom_hotwords.php b/dlp/src/inspect_column_values_w_custom_hotwords.php
new file mode 100644
index 0000000000..52846b1d51
--- /dev/null
+++ b/dlp/src/inspect_column_values_w_custom_hotwords.php
@@ -0,0 +1,138 @@
+setHeaders([
+ (new FieldId())
+ ->setName('Fake Social Security Number'),
+ (new FieldId())
+ ->setName('Real Social Security Number'),
+ ])
+ ->setRows([
+ (new Row())->setValues([
+ (new Value())
+ ->setStringValue('111-11-1111'),
+ (new Value())
+ ->setStringValue('222-22-2222')
+ ])
+ ]);
+
+ $item = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the regex pattern the inspection will look for.
+ $hotwordRegexPattern = 'Fake Social Security Number';
+
+ // Specify hotword likelihood adjustment.
+ $likelihoodAdjustment = (new LikelihoodAdjustment())
+ ->setFixedLikelihood(Likelihood::VERY_UNLIKELY);
+
+ // Specify a window around a finding to apply a detection rule.
+ $proximity = (new Proximity())
+ ->setWindowBefore(1);
+
+ // Construct the hotword rule.
+ $hotwordRule = (new HotwordRule())
+ ->setHotwordRegex((new Regex())
+ ->setPattern($hotwordRegexPattern))
+ ->setLikelihoodAdjustment($likelihoodAdjustment)
+ ->setProximity($proximity);
+
+ // Construct rule set for the inspect config.
+ $infotype = (new InfoType())
+ ->setName('US_SOCIAL_SECURITY_NUMBER');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$infotype])
+ ->setRules([
+ (new InspectionRule())
+ ->setHotwordRule($hotwordRule)
+ ]);
+
+ // Construct the configuration for the Inspect request.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$infotype])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet])
+ ->setMinLikelihood(Likelihood::POSSIBLE);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_column_values_w_custom_hotwords]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_image_all_infotypes.php b/dlp/src/inspect_image_all_infotypes.php
new file mode 100644
index 0000000000..3769d58a19
--- /dev/null
+++ b/dlp/src/inspect_image_all_infotypes.php
@@ -0,0 +1,85 @@
+setType(BytesType::IMAGE_PNG)
+ ->setData(file_get_contents($inputPath));
+
+ $parent = "projects/$projectId/locations/global";
+
+ // Specify what content you want the service to Inspect.
+ $item = (new ContentItem())
+ ->setByteItem($fileBytes);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+
+# [END dlp_inspect_image_all_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_image_listed_infotypes.php b/dlp/src/inspect_image_listed_infotypes.php
new file mode 100644
index 0000000000..8ce1d68c31
--- /dev/null
+++ b/dlp/src/inspect_image_listed_infotypes.php
@@ -0,0 +1,96 @@
+setType(BytesType::IMAGE_PNG)
+ ->setData(file_get_contents($inputPath));
+
+ $parent = "projects/$projectId/locations/global";
+
+ // Specify what content you want the service to Inspect.
+ $item = (new ContentItem())
+ ->setByteItem($fileBytes);
+
+ // Create inspect config configuration.
+ $inspectConfig = (new InspectConfig())
+ // The infoTypes of information to match.
+ ->setInfoTypes([
+ (new InfoType())->setName('PHONE_NUMBER'),
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('US_SOCIAL_SECURITY_NUMBER')
+ ]);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+
+// [END dlp_inspect_image_listed_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_table.php b/dlp/src/inspect_table.php
new file mode 100644
index 0000000000..682dd576c6
--- /dev/null
+++ b/dlp/src/inspect_table.php
@@ -0,0 +1,101 @@
+setHeaders([
+ (new FieldId())
+ ->setName('NAME'),
+ (new FieldId())
+ ->setName('PHONE'),
+ ])
+ ->setRows([
+ (new Row())->setValues([
+ (new Value())
+ ->setStringValue('John Doe'),
+ (new Value())
+ ->setStringValue('(206) 555-0123')
+ ])
+ ]);
+
+ $item = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Construct the configuration for the Inspect request.
+ $phoneNumber = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$phoneNumber])
+ ->setIncludeQuote(true);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+// [END dlp_inspect_table]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 54358fe795..a7c92e5a25 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -575,4 +575,73 @@ public function testDeidentifyTableRowSuppress()
$this->assertEquals(3, count($csvLines_ouput));
unlink($outputCsvFile);
}
+
+ public function testInspectImageAllInfoTypes()
+ {
+ $output = $this->runFunctionSnippet('inspect_image_all_infotypes', [
+ self::$projectId,
+ __DIR__ . '/data/test.png'
+ ]);
+ $this->assertStringContainsString('Info type: PHONE_NUMBER', $output);
+ $this->assertStringContainsString('Info type: PERSON_NAME', $output);
+ $this->assertStringContainsString('Info type: EMAIL_ADDRESS', $output);
+ }
+
+ public function testInspectImageListedInfotypes()
+ {
+ $output = $this->runFunctionSnippet('inspect_image_listed_infotypes', [
+ self::$projectId,
+ __DIR__ . '/data/test.png'
+ ]);
+
+ $this->assertStringContainsString('Info type: EMAIL_ADDRESS', $output);
+ $this->assertStringContainsString('Info type: PHONE_NUMBER', $output);
+ }
+
+ public function testInspectAugmentInfotypes()
+ {
+ $textToInspect = "The patient's name is Quasimodo";
+ $matchWordList = ['quasimodo'];
+ $output = $this->runFunctionSnippet('inspect_augment_infotypes', [
+ self::$projectId,
+ $textToInspect,
+ $matchWordList
+ ]);
+ $this->assertStringContainsString('Quote: Quasimodo', $output);
+ $this->assertStringContainsString('Info type: PERSON_NAME', $output);
+ }
+
+ public function testInspectAugmentInfotypesIgnore()
+ {
+ $textToInspect = 'My mobile number is 9545141023';
+ $matchWordList = ['quasimodo'];
+ $output = $this->runFunctionSnippet('inspect_augment_infotypes', [
+ self::$projectId,
+ $textToInspect,
+ $matchWordList
+ ]);
+ $this->assertStringContainsString('No findings.', $output);
+ }
+
+ public function testInspectColumnValuesWCustomHotwords()
+ {
+ $output = $this->runFunctionSnippet('inspect_column_values_w_custom_hotwords', [
+ self::$projectId,
+ ]);
+ $this->assertStringContainsString('Info type: US_SOCIAL_SECURITY_NUMBER', $output);
+ $this->assertStringContainsString('Likelihood: VERY_LIKELY', $output);
+ $this->assertStringContainsString('Quote: 222-22-2222', $output);
+ $this->assertStringNotContainsString('111-11-1111', $output);
+ }
+
+ public function testInspectTable()
+ {
+ $output = $this->runFunctionSnippet('inspect_table', [
+ self::$projectId
+ ]);
+
+ $this->assertStringContainsString('Info type: PHONE_NUMBER', $output);
+ $this->assertStringContainsString('Quote: (206) 555-0123', $output);
+ $this->assertStringNotContainsString('Info type: PERSON_NAME', $output);
+ }
}
From ffaf6c4daa080145528038bbcaa6798ed3961add Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Tue, 30 May 2023 22:54:56 +0530
Subject: [PATCH 031/285] feat(dlp): add redact data from image samples (#1851)
---
dlp/src/redact_image_all_infotypes.php | 81 ++++++++++++++
dlp/src/redact_image_all_text.php | 87 +++++++++++++++
dlp/src/redact_image_colored_infotypes.php | 122 +++++++++++++++++++++
dlp/src/redact_image_listed_infotypes.php | 108 ++++++++++++++++++
dlp/test/dlpTest.php | 68 ++++++++++++
5 files changed, 466 insertions(+)
create mode 100644 dlp/src/redact_image_all_infotypes.php
create mode 100644 dlp/src/redact_image_all_text.php
create mode 100644 dlp/src/redact_image_colored_infotypes.php
create mode 100644 dlp/src/redact_image_listed_infotypes.php
diff --git a/dlp/src/redact_image_all_infotypes.php b/dlp/src/redact_image_all_infotypes.php
new file mode 100644
index 0000000000..11dfbe737a
--- /dev/null
+++ b/dlp/src/redact_image_all_infotypes.php
@@ -0,0 +1,81 @@
+setType($typeConstant)
+ ->setData($imageBytes);
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request.
+ $response = $dlp->redactImage([
+ 'parent' => $parent,
+ 'byteItem' => $byteContent,
+ ]);
+
+ // Save result to file.
+ file_put_contents($outputPath, $response->getRedactedImage());
+
+ // Print completion message.
+ printf('Redacted image saved to %s ' . PHP_EOL, $outputPath);
+}
+# [END dlp_redact_image_all_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/redact_image_all_text.php b/dlp/src/redact_image_all_text.php
new file mode 100644
index 0000000000..b6a213231c
--- /dev/null
+++ b/dlp/src/redact_image_all_text.php
@@ -0,0 +1,87 @@
+setType($typeConstant)
+ ->setData($imageBytes);
+
+ // Enable redaction of all text.
+ $imageRedactionConfig = (new ImageRedactionConfig())
+ ->setRedactAllText(true);
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request.
+ $response = $dlp->redactImage([
+ 'parent' => $parent,
+ 'byteItem' => $byteContent,
+ 'imageRedactionConfigs' => [$imageRedactionConfig]
+ ]);
+
+ // Save result to file.
+ file_put_contents($outputPath, $response->getRedactedImage());
+
+ // Print completion message.
+ printf('Redacted image saved to %s' . PHP_EOL, $outputPath);
+}
+# [END dlp_redact_image_all_text]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/redact_image_colored_infotypes.php b/dlp/src/redact_image_colored_infotypes.php
new file mode 100644
index 0000000000..610203fabe
--- /dev/null
+++ b/dlp/src/redact_image_colored_infotypes.php
@@ -0,0 +1,122 @@
+setType($typeConstant)
+ ->setData($imageBytes);
+
+ // Define the types of information to redact and associate each one with a different color.
+ $ssnInfotype = (new InfoType())
+ ->setName('US_SOCIAL_SECURITY_NUMBER');
+ $emailInfotype = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $phoneInfotype = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $infotypes = [$ssnInfotype, $emailInfotype, $phoneInfotype];
+
+ $ssnRedactionConfig = (new ImageRedactionConfig())
+ ->setInfoType($ssnInfotype)
+ ->setRedactionColor((new Color())
+ ->setRed(.3)
+ ->setGreen(.1)
+ ->setBlue(.6));
+
+ $emailRedactionConfig = (new ImageRedactionConfig())
+ ->setInfoType($emailInfotype)
+ ->setRedactionColor((new Color())
+ ->setRed(.5)
+ ->setGreen(.5)
+ ->setBlue(1));
+
+ $phoneRedactionConfig = (new ImageRedactionConfig())
+ ->setInfoType($phoneInfotype)
+ ->setRedactionColor((new Color())
+ ->setRed(1)
+ ->setGreen(0)
+ ->setBlue(.6));
+
+ $imageRedactionConfigs = [$ssnRedactionConfig, $emailRedactionConfig, $phoneRedactionConfig];
+
+ // Create the configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infotypes);
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request.
+ $response = $dlp->redactImage([
+ 'parent' => $parent,
+ 'byteItem' => $byteContent,
+ 'inspectConfig' => $inspectConfig,
+ 'imageRedactionConfigs' => $imageRedactionConfigs
+ ]);
+
+ // Save result to file.
+ file_put_contents($outputPath, $response->getRedactedImage());
+
+ // Print completion message.
+ printf('Redacted image saved to %s ' . PHP_EOL, $outputPath);
+}
+# [END dlp_redact_image_colored_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/redact_image_listed_infotypes.php b/dlp/src/redact_image_listed_infotypes.php
new file mode 100644
index 0000000000..caf983ed39
--- /dev/null
+++ b/dlp/src/redact_image_listed_infotypes.php
@@ -0,0 +1,108 @@
+setName('US_SOCIAL_SECURITY_NUMBER'),
+ (new InfoType())
+ ->setName('EMAIL_ADDRESS'),
+ (new InfoType())
+ ->setName('PHONE_NUMBER'),
+ ];
+
+ // Create the configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes);
+
+ // Read image file into a buffer.
+ $imageRef = fopen($imagePath, 'rb');
+ $imageBytes = fread($imageRef, filesize($imagePath));
+ fclose($imageRef);
+
+ // Get the image's content type.
+ $typeConstant = (int) array_search(
+ mime_content_type($imagePath),
+ [false, 'image/jpeg', 'image/bmp', 'image/png', 'image/svg']
+ );
+
+ // Create the byte-storing object.
+ $byteContent = (new ByteContentItem())
+ ->setType($typeConstant)
+ ->setData($imageBytes);
+
+ // Create the image redaction config objects.
+ $imageRedactionConfigs = [];
+ foreach ($infoTypes as $infoType) {
+ $config = (new ImageRedactionConfig())
+ ->setInfoType($infoType);
+ $imageRedactionConfigs[] = $config;
+ }
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Run request.
+ $response = $dlp->redactImage([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'byteItem' => $byteContent,
+ 'imageRedactionConfigs' => $imageRedactionConfigs
+ ]);
+
+ // Save result to file.
+ file_put_contents($outputPath, $response->getRedactedImage());
+
+ // Print completion message.
+ printf('Redacted image saved to %s' . PHP_EOL, $outputPath);
+}
+# [END dlp_redact_image_listed_infotypes]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index a7c92e5a25..77ca22c622 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -644,4 +644,72 @@ public function testInspectTable()
$this->assertStringContainsString('Quote: (206) 555-0123', $output);
$this->assertStringNotContainsString('Info type: PERSON_NAME', $output);
}
+
+ public function testRedactImageListedInfotypes()
+ {
+ $imagePath = __DIR__ . '/data/test.png';
+ $outputPath = __DIR__ . '/data/redact_image_listed_infotypes-unittest.png';
+
+ $output = $this->runFunctionSnippet('redact_image_listed_infotypes', [
+ self::$projectId,
+ $imagePath,
+ $outputPath,
+ ]);
+ $this->assertNotEquals(
+ sha1_file($outputPath),
+ sha1_file($imagePath)
+ );
+ unlink($outputPath);
+ }
+
+ public function testRedactImageAllText()
+ {
+ $imagePath = __DIR__ . '/data/test.png';
+ $outputPath = __DIR__ . '/data/redact_image_all_text-unittest.png';
+
+ $output = $this->runFunctionSnippet('redact_image_all_text', [
+ self::$projectId,
+ $imagePath,
+ $outputPath,
+ ]);
+ $this->assertNotEquals(
+ sha1_file($outputPath),
+ sha1_file($imagePath)
+ );
+ unlink($outputPath);
+ }
+
+ public function testRedactImageAllInfoTypes()
+ {
+ $imagePath = __DIR__ . '/data/test.png';
+ $outputPath = __DIR__ . '/data/redact_image_all_infotypes-unittest.png';
+
+ $output = $this->runFunctionSnippet('redact_image_all_infotypes', [
+ self::$projectId,
+ $imagePath,
+ $outputPath,
+ ]);
+ $this->assertNotEquals(
+ sha1_file($outputPath),
+ sha1_file($imagePath)
+ );
+ unlink($outputPath);
+ }
+
+ public function testRedactImageColoredInfotypes()
+ {
+ $imagePath = __DIR__ . '/data/test.png';
+ $outputPath = __DIR__ . '/data/sensitive-data-image-redacted-color-coding-unittest.png';
+
+ $output = $this->runFunctionSnippet('redact_image_colored_infotypes', [
+ self::$projectId,
+ $imagePath,
+ $outputPath,
+ ]);
+ $this->assertNotEquals(
+ sha1_file($outputPath),
+ sha1_file($imagePath)
+ );
+ unlink($outputPath);
+ }
}
From eb390be07bd052513ad111f98193368831747ef9 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Tue, 30 May 2023 22:55:40 +0530
Subject: [PATCH 032/285] feat(dlp): add inspect string custom hotword sample
(#1824)
---
dlp/src/inspect_string_custom_hotword.php | 117 ++++++++++++++++++++++
dlp/test/dlpTest.php | 10 ++
2 files changed, 127 insertions(+)
create mode 100644 dlp/src/inspect_string_custom_hotword.php
diff --git a/dlp/src/inspect_string_custom_hotword.php b/dlp/src/inspect_string_custom_hotword.php
new file mode 100644
index 0000000000..90a415bdfd
--- /dev/null
+++ b/dlp/src/inspect_string_custom_hotword.php
@@ -0,0 +1,117 @@
+setValue($textToInspect);
+
+ // Construct hotword rules
+ $hotwordRule = (new HotwordRule())
+ ->setHotwordRegex(
+ (new Regex())
+ ->setPattern('patient')
+ )
+ ->setProximity(
+ (new Proximity())
+ ->setWindowBefore(50)
+ )
+ ->setLikelihoodAdjustment(
+ (new LikelihoodAdjustment())
+ ->setFixedLikelihood(Likelihood::VERY_LIKELY)
+ );
+
+ // Construct a ruleset that applies the hotword rule to the PERSON_NAME infotype.
+ $personName = (new InfoType())
+ ->setName('PERSON_NAME');
+ $inspectionRuleSet = (new InspectionRuleSet())
+ ->setInfoTypes([$personName])
+ ->setRules([
+ (new InspectionRule())
+ ->setHotwordRule($hotwordRule),
+ ]);
+
+ // Construct the configuration for the Inspect request, including the ruleset.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$personName])
+ ->setIncludeQuote(true)
+ ->setRuleSet([$inspectionRuleSet])
+ ->setMinLikelihood(Likelihood::VERY_LIKELY);
+
+ // Run request
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_string_custom_hotword]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 77ca22c622..7c038598f8 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -413,6 +413,16 @@ public function testInspectStringMultipleRulesRedactedRule()
$this->assertStringContainsString('No findings.', $output);
}
+ public function testInspectStringCustomHotword()
+ {
+ $output = $this->runFunctionSnippet('inspect_string_custom_hotword', [
+ self::$projectId,
+ 'patient name: John Doe'
+ ]);
+ $this->assertStringContainsString('Info type: PERSON_NAME', $output);
+ $this->assertStringContainsString('Likelihood: VERY_LIKELY', $output);
+ }
+
public function testInspectStringWithExclusionRegex()
{
$output = $this->runFunctionSnippet('inspect_string_with_exclusion_regex', [
From 29c9bb31c91660d3f710555d5f8b77f4dd52f0e5 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 1 Jun 2023 10:20:21 -0700
Subject: [PATCH 033/285] feat: update secretmanager to new (beta) v2gapic
surface (#1829)
---
secretmanager/src/access_secret_version.php | 8 +++++--
secretmanager/src/add_secret_version.php | 15 ++++++++-----
secretmanager/src/create_secret.php | 22 +++++++++++--------
...e_secret_with_user_managed_replication.php | 10 ++++++---
secretmanager/src/delete_secret.php | 8 +++++--
secretmanager/src/destroy_secret_version.php | 8 +++++--
secretmanager/src/disable_secret_version.php | 8 +++++--
secretmanager/src/enable_secret_version.php | 8 +++++--
secretmanager/src/get_secret.php | 8 +++++--
secretmanager/src/get_secret_version.php | 8 +++++--
secretmanager/src/iam_grant_access.php | 13 ++++++++---
secretmanager/src/iam_revoke_access.php | 13 ++++++++---
secretmanager/src/list_secret_versions.php | 8 +++++--
secretmanager/src/list_secrets.php | 8 +++++--
secretmanager/src/update_secret.php | 8 +++++--
.../src/update_secret_with_alias.php | 8 +++++--
16 files changed, 116 insertions(+), 45 deletions(-)
diff --git a/secretmanager/src/access_secret_version.php b/secretmanager/src/access_secret_version.php
index 2dbad57e98..f4e2db5549 100644
--- a/secretmanager/src/access_secret_version.php
+++ b/secretmanager/src/access_secret_version.php
@@ -27,7 +27,8 @@
// [START secretmanager_access_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\AccessSecretVersionRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -42,8 +43,11 @@ function access_secret_version(string $projectId, string $secretId, string $vers
// Build the resource name of the secret version.
$name = $client->secretVersionName($projectId, $secretId, $versionId);
+ // Build the request.
+ $request = AccessSecretVersionRequest::build($name);
+
// Access the secret version.
- $response = $client->accessSecretVersion($name);
+ $response = $client->accessSecretVersion($request);
// Print the secret payload.
//
diff --git a/secretmanager/src/add_secret_version.php b/secretmanager/src/add_secret_version.php
index ed585ba318..a84e0a75e4 100644
--- a/secretmanager/src/add_secret_version.php
+++ b/secretmanager/src/add_secret_version.php
@@ -27,7 +27,8 @@
// [START secretmanager_add_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\AddSecretVersionRequest;
use Google\Cloud\SecretManager\V1\SecretPayload;
/**
@@ -39,13 +40,17 @@ function add_secret_version(string $projectId, string $secretId): void
// Create the Secret Manager client.
$client = new SecretManagerServiceClient();
- // Build the resource name of the parent secret.
+ // Build the resource name of the parent secret and the payload.
$parent = $client->secretName($projectId, $secretId);
+ $secretPayload = new SecretPayload([
+ 'data' => 'my super secret data',
+ ]);
+
+ // Build the request.
+ $request = AddSecretVersionRequest::build($parent, $secretPayload);
// Access the secret version.
- $response = $client->addSecretVersion($parent, new SecretPayload([
- 'data' => 'my super secret data',
- ]));
+ $response = $client->addSecretVersion($request);
// Print the new secret version name.
printf('Added secret version: %s', $response->getName());
diff --git a/secretmanager/src/create_secret.php b/secretmanager/src/create_secret.php
index 30a46561c4..701188ea18 100644
--- a/secretmanager/src/create_secret.php
+++ b/secretmanager/src/create_secret.php
@@ -27,10 +27,11 @@
// [START secretmanager_create_secret]
// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Replication;
use Google\Cloud\SecretManager\V1\Replication\Automatic;
use Google\Cloud\SecretManager\V1\Secret;
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -44,17 +45,20 @@ function create_secret(string $projectId, string $secretId): void
// Build the resource name of the parent project.
$parent = $client->projectName($projectId);
+ $secret = new Secret([
+ 'replication' => new Replication([
+ 'automatic' => new Automatic(),
+ ]),
+ ]);
+
+ // Build the request.
+ $request = CreateSecretRequest::build($parent, $secretId, $secret);
+
// Create the secret.
- $secret = $client->createSecret($parent, $secretId,
- new Secret([
- 'replication' => new Replication([
- 'automatic' => new Automatic(),
- ]),
- ])
- );
+ $newSecret = $client->createSecret($request);
// Print the new secret name.
- printf('Created secret: %s', $secret->getName());
+ printf('Created secret: %s', $newSecret->getName());
}
// [END secretmanager_create_secret]
diff --git a/secretmanager/src/create_secret_with_user_managed_replication.php b/secretmanager/src/create_secret_with_user_managed_replication.php
index 0fe2df5d0f..9985caccc8 100644
--- a/secretmanager/src/create_secret_with_user_managed_replication.php
+++ b/secretmanager/src/create_secret_with_user_managed_replication.php
@@ -26,11 +26,12 @@
namespace Google\Cloud\Samples\SecretManager;
// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Replication;
use Google\Cloud\SecretManager\V1\Replication\UserManaged;
use Google\Cloud\SecretManager\V1\Replication\UserManaged\Replica;
use Google\Cloud\SecretManager\V1\Secret;
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -58,11 +59,14 @@ function create_secret_with_user_managed_replication(string $projectId, string $
]),
]);
+ // Build the request.
+ $request = CreateSecretRequest::build($parent, $secretId, $secret);
+
// Create the secret.
- $secret = $client->createSecret($parent, $secretId, $secret);
+ $newSecret = $client->createSecret($request);
// Print the new secret name.
- printf('Created secret: %s', $secret->getName());
+ printf('Created secret: %s', $newSecret->getName());
}
// The following 2 lines are only needed to execute the samples on the CLI
diff --git a/secretmanager/src/delete_secret.php b/secretmanager/src/delete_secret.php
index 7f7c7b8e1e..fbbafc7c5d 100644
--- a/secretmanager/src/delete_secret.php
+++ b/secretmanager/src/delete_secret.php
@@ -27,7 +27,8 @@
// [START secretmanager_delete_secret]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\DeleteSecretRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -41,8 +42,11 @@ function delete_secret(string $projectId, string $secretId): void
// Build the resource name of the secret.
$name = $client->secretName($projectId, $secretId);
+ // Build the request.
+ $request = DeleteSecretRequest::build($name);
+
// Delete the secret.
- $client->deleteSecret($name);
+ $client->deleteSecret($request);
printf('Deleted secret %s', $secretId);
}
// [END secretmanager_delete_secret]
diff --git a/secretmanager/src/destroy_secret_version.php b/secretmanager/src/destroy_secret_version.php
index a26bf681b3..ba8f14bc78 100644
--- a/secretmanager/src/destroy_secret_version.php
+++ b/secretmanager/src/destroy_secret_version.php
@@ -27,7 +27,8 @@
// [START secretmanager_destroy_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\DestroySecretVersionRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -42,8 +43,11 @@ function destroy_secret_version(string $projectId, string $secretId, string $ver
// Build the resource name of the secret version.
$name = $client->secretVersionName($projectId, $secretId, $versionId);
+ // Build the request.
+ $request = DestroySecretVersionRequest::build($name);
+
// Destroy the secret version.
- $response = $client->destroySecretVersion($name);
+ $response = $client->destroySecretVersion($request);
// Print a success message.
printf('Destroyed secret version: %s', $response->getName());
diff --git a/secretmanager/src/disable_secret_version.php b/secretmanager/src/disable_secret_version.php
index 7866b9cb02..be63b5f1a4 100644
--- a/secretmanager/src/disable_secret_version.php
+++ b/secretmanager/src/disable_secret_version.php
@@ -27,7 +27,8 @@
// [START secretmanager_disable_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\DisableSecretVersionRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -42,8 +43,11 @@ function disable_secret_version(string $projectId, string $secretId, string $ver
// Build the resource name of the secret version.
$name = $client->secretVersionName($projectId, $secretId, $versionId);
+ // Build the request.
+ $request = DisableSecretVersionRequest::build($name);
+
// Disable the secret version.
- $response = $client->disableSecretVersion($name);
+ $response = $client->disableSecretVersion($request);
// Print a success message.
printf('Disabled secret version: %s', $response->getName());
diff --git a/secretmanager/src/enable_secret_version.php b/secretmanager/src/enable_secret_version.php
index 23a3251be4..6bf3cae83a 100644
--- a/secretmanager/src/enable_secret_version.php
+++ b/secretmanager/src/enable_secret_version.php
@@ -27,7 +27,8 @@
// [START secretmanager_enable_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\EnableSecretVersionRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -42,8 +43,11 @@ function enable_secret_version(string $projectId, string $secretId, string $vers
// Build the resource name of the secret version.
$name = $client->secretVersionName($projectId, $secretId, $versionId);
+ // Build the request.
+ $request = EnableSecretVersionRequest::build($name);
+
// Enable the secret version.
- $response = $client->enableSecretVersion($name);
+ $response = $client->enableSecretVersion($request);
// Print a success message.
printf('Enabled secret version: %s', $response->getName());
diff --git a/secretmanager/src/get_secret.php b/secretmanager/src/get_secret.php
index 32c31712e1..e1684f6f11 100644
--- a/secretmanager/src/get_secret.php
+++ b/secretmanager/src/get_secret.php
@@ -27,7 +27,8 @@
// [START secretmanager_get_secret]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\GetSecretRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -41,8 +42,11 @@ function get_secret(string $projectId, string $secretId): void
// Build the resource name of the secret.
$name = $client->secretName($projectId, $secretId);
+ // Build the request.
+ $request = GetSecretRequest::build($name);
+
// Get the secret.
- $secret = $client->getSecret($name);
+ $secret = $client->getSecret($request);
// Get the replication policy.
$replication = strtoupper($secret->getReplication()->getReplication());
diff --git a/secretmanager/src/get_secret_version.php b/secretmanager/src/get_secret_version.php
index 10089642a7..f5a87c09dc 100644
--- a/secretmanager/src/get_secret_version.php
+++ b/secretmanager/src/get_secret_version.php
@@ -27,8 +27,9 @@
// [START secretmanager_get_secret_version]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\SecretVersion\State;
+use Google\Cloud\SecretManager\V1\GetSecretVersionRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -43,8 +44,11 @@ function get_secret_version(string $projectId, string $secretId, string $version
// Build the resource name of the secret version.
$name = $client->secretVersionName($projectId, $secretId, $versionId);
+ // Build the request.
+ $request = GetSecretVersionRequest::build($name);
+
// Access the secret version.
- $response = $client->getSecretVersion($name);
+ $response = $client->getSecretVersion($request);
// Get the state string from the enum.
$state = State::name($response->getState());
diff --git a/secretmanager/src/iam_grant_access.php b/secretmanager/src/iam_grant_access.php
index 4272447aa1..1c3615e343 100644
--- a/secretmanager/src/iam_grant_access.php
+++ b/secretmanager/src/iam_grant_access.php
@@ -27,10 +27,12 @@
// [START secretmanager_iam_grant_access]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
// Import the Secret Manager IAM library.
use Google\Cloud\Iam\V1\Binding;
+use Google\Cloud\Iam\V1\GetIamPolicyRequest;
+use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -46,7 +48,7 @@ function iam_grant_access(string $projectId, string $secretId, string $member):
$name = $client->secretName($projectId, $secretId);
// Get the current IAM policy.
- $policy = $client->getIamPolicy($name);
+ $policy = $client->getIamPolicy((new GetIamPolicyRequest)->setResource($name));
// Update the bindings to include the new member.
$bindings = $policy->getBindings();
@@ -56,8 +58,13 @@ function iam_grant_access(string $projectId, string $secretId, string $member):
]);
$policy->setBindings($bindings);
+ // Build the request.
+ $request = (new SetIamPolicyRequest)
+ ->setResource($name)
+ ->setPolicy($policy);
+
// Save the updated policy to the server.
- $client->setIamPolicy($name, $policy);
+ $client->setIamPolicy($request);
// Print out a success message.
printf('Updated IAM policy for %s', $secretId);
diff --git a/secretmanager/src/iam_revoke_access.php b/secretmanager/src/iam_revoke_access.php
index 5449e9961e..d16f27d70f 100644
--- a/secretmanager/src/iam_revoke_access.php
+++ b/secretmanager/src/iam_revoke_access.php
@@ -27,7 +27,9 @@
// [START secretmanager_iam_revoke_access]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\Iam\V1\GetIamPolicyRequest;
+use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -43,7 +45,7 @@ function iam_revoke_access(string $projectId, string $secretId, string $member):
$name = $client->secretName($projectId, $secretId);
// Get the current IAM policy.
- $policy = $client->getIamPolicy($name);
+ $policy = $client->getIamPolicy((new GetIamPolicyRequest)->setResource($name));
// Remove the member from the list of bindings.
foreach ($policy->getBindings() as $binding) {
@@ -59,8 +61,13 @@ function iam_revoke_access(string $projectId, string $secretId, string $member):
}
}
+ // Build the request.
+ $request = (new SetIamPolicyRequest)
+ ->setResource($name)
+ ->setPolicy($policy);
+
// Save the updated policy to the server.
- $client->setIamPolicy($name, $policy);
+ $client->setIamPolicy($request);
// Print out a success message.
printf('Updated IAM policy for %s', $secretId);
diff --git a/secretmanager/src/list_secret_versions.php b/secretmanager/src/list_secret_versions.php
index 9a5bbc5e7c..077720e580 100644
--- a/secretmanager/src/list_secret_versions.php
+++ b/secretmanager/src/list_secret_versions.php
@@ -27,7 +27,8 @@
// [START secretmanager_list_secret_versions]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\ListSecretVersionsRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -41,8 +42,11 @@ function list_secret_versions(string $projectId, string $secretId): void
// Build the resource name of the parent secret.
$parent = $client->secretName($projectId, $secretId);
+ // Build the request.
+ $request = ListSecretVersionsRequest::build($parent);
+
// List all secret versions.
- foreach ($client->listSecretVersions($parent) as $version) {
+ foreach ($client->listSecretVersions($request) as $version) {
printf('Found secret version %s', $version->getName());
}
}
diff --git a/secretmanager/src/list_secrets.php b/secretmanager/src/list_secrets.php
index f7108d7dc3..be0bfa58e0 100644
--- a/secretmanager/src/list_secrets.php
+++ b/secretmanager/src/list_secrets.php
@@ -27,7 +27,8 @@
// [START secretmanager_list_secrets]
// Import the Secret Manager client library.
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\ListSecretsRequest;
/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
@@ -40,8 +41,11 @@ function list_secrets(string $projectId): void
// Build the resource name of the parent secret.
$parent = $client->projectName($projectId);
+ // Build the request.
+ $request = ListSecretsRequest::build($parent);
+
// List all secrets.
- foreach ($client->listSecrets($parent) as $secret) {
+ foreach ($client->listSecrets($request) as $secret) {
printf('Found secret %s', $secret->getName());
}
}
diff --git a/secretmanager/src/update_secret.php b/secretmanager/src/update_secret.php
index ec49e62dc8..2abdb99788 100644
--- a/secretmanager/src/update_secret.php
+++ b/secretmanager/src/update_secret.php
@@ -28,7 +28,8 @@
// [START secretmanager_update_secret]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\Secret;
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\FieldMask;
/**
@@ -51,7 +52,10 @@ function update_secret(string $projectId, string $secretId): void
$updateMask = (new FieldMask())
->setPaths(['labels']);
- $response = $client->updateSecret($secret, $updateMask);
+ // Build the request.
+ $request = UpdateSecretRequest::build($secret, $updateMask);
+
+ $response = $client->updateSecret($request);
// Print the upated secret.
printf('Updated secret: %s', $response->getName());
diff --git a/secretmanager/src/update_secret_with_alias.php b/secretmanager/src/update_secret_with_alias.php
index 82ede70b00..281c01c927 100644
--- a/secretmanager/src/update_secret_with_alias.php
+++ b/secretmanager/src/update_secret_with_alias.php
@@ -28,7 +28,8 @@
// [START secretmanager_update_secret_with_alias]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\Secret;
-use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\FieldMask;
/**
@@ -51,7 +52,10 @@ function update_secret_with_alias(string $projectId, string $secretId): void
$updateMask = (new FieldMask())
->setPaths(['version_aliases']);
- $response = $client->updateSecret($secret, $updateMask);
+ // Build the request.
+ $request = UpdateSecretRequest::build($secret, $updateMask);
+
+ $response = $client->updateSecret($request);
// Print the upated secret.
printf('Updated secret: %s', $response->getName());
From 76706dc06c2943efc876fdffd02986b390c0d8a5 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 5 Jun 2023 21:55:08 +0530
Subject: [PATCH 034/285] feat(dlp): implement create_and_get_job sample
(#1848)
---
dlp/src/create_job.php | 115 +++++++++++++++++++++++++++++++++++++++++
dlp/src/get_job.php | 51 ++++++++++++++++++
dlp/test/dlpTest.php | 38 ++++++++++++++
3 files changed, 204 insertions(+)
create mode 100644 dlp/src/create_job.php
create mode 100644 dlp/src/get_job.php
diff --git a/dlp/src/create_job.php b/dlp/src/create_job.php
new file mode 100644
index 0000000000..e83f417526
--- /dev/null
+++ b/dlp/src/create_job.php
@@ -0,0 +1,115 @@
+setEnableAutoPopulationOfTimespanConfig(true);
+
+ // Specify the GCS file to be inspected.
+ $cloudStorageOptions = (new CloudStorageOptions())
+ ->setFileSet((new FileSet())
+ ->setUrl($gcsPath));
+ $storageConfig = (new StorageConfig())
+ ->setCloudStorageOptions(($cloudStorageOptions))
+ ->setTimespanConfig($timespanConfig);
+
+ // ----- Construct inspection config -----
+ $emailAddressInfoType = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $personNameInfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+ $locationInfoType = (new InfoType())
+ ->setName('LOCATION');
+ $phoneNumberInfoType = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $infoTypes = [$emailAddressInfoType, $personNameInfoType, $locationInfoType, $phoneNumberInfoType];
+
+ // Whether to include the matching string in the response.
+ $includeQuote = true;
+ // The minimum likelihood required before returning a match.
+ $minLikelihood = likelihood::LIKELIHOOD_UNSPECIFIED;
+
+ // The maximum number of findings to report (0 = server maximum).
+ $limits = (new FindingLimits())
+ ->setMaxFindingsPerRequest(100);
+
+ // Create the Inspect configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setMinLikelihood($minLikelihood)
+ ->setLimits($limits)
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote($includeQuote);
+
+ // Specify the action that is triggered when the job completes.
+ $action = (new Action())
+ ->setPublishSummaryToCscc(new PublishSummaryToCscc());
+
+ // Configure the inspection job we want the service to perform.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Send the job creation request and process the response.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJobConfig
+ ]);
+
+ // Print results.
+ printf($job->getName());
+}
+# [END dlp_create_job]
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/get_job.php b/dlp/src/get_job.php
new file mode 100644
index 0000000000..7094511cc0
--- /dev/null
+++ b/dlp/src/get_job.php
@@ -0,0 +1,51 @@
+getDlpJob($jobName);
+ printf('Job %s status: %s' . PHP_EOL, $response->getName(), $response->getState());
+ } finally {
+ $dlp->close();
+ }
+}
+# [END dlp_get_job]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 7c038598f8..d4637ef28c 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -655,6 +655,44 @@ public function testInspectTable()
$this->assertStringNotContainsString('Info type: PERSON_NAME', $output);
}
+ public function testGetJob()
+ {
+
+ // Set filter to only go back a day, so that we do not pull every job.
+ $filter = sprintf(
+ 'state=DONE AND end_time>"%sT00:00:00+00:00"',
+ date('Y-m-d', strtotime('-1 day'))
+ );
+ $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
+ $getJobName = $this->runFunctionSnippet('list_jobs', [
+ self::$projectId,
+ $filter,
+ ]);
+ preg_match($jobIdRegex, $getJobName, $jobIds);
+ $jobName = $jobIds[0];
+
+ $output = $this->runFunctionSnippet('get_job', [
+ $jobName
+ ]);
+ $this->assertStringContainsString('Job ' . $jobName . ' status:', $output);
+ }
+
+ public function testCreateJob()
+ {
+ $gcsPath = $this->requireEnv('GCS_PATH');
+ $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
+ $jobName = $this->runFunctionSnippet('create_job', [
+ self::$projectId,
+ $gcsPath
+ ]);
+ $this->assertRegExp($jobIdRegex, $jobName);
+ $output = $this->runFunctionSnippet(
+ 'delete_job',
+ [$jobName]
+ );
+ $this->assertStringContainsString('Successfully deleted job ' . $jobName, $output);
+ }
+
public function testRedactImageListedInfotypes()
{
$imagePath = __DIR__ . '/data/test.png';
From 384a0f06fd88024f6477126035f5b7b7b19681b3 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 12 Jun 2023 23:54:24 +0530
Subject: [PATCH 035/285] feat(dlp): de-identify and re-identify samples
(#1852)
* Implemented deidentify_and_reidentify_samples
* Changes in deidentify_and_reidentify_samples
* Changes in deidentify_and_reidentify_samples
* Changes in deidentify_and_reidentify_samples
* I have changed the Regexp in testDeidReidDeterministic
---
dlp/src/deidentify_deterministic.php | 126 ++++++++++++++
...ify_free_text_with_fpe_using_surrogate.php | 133 +++++++++++++++
dlp/src/deidentify_table_fpe.php | 156 ++++++++++++++++++
dlp/src/reidentify_deterministic.php | 122 ++++++++++++++
...ify_free_text_with_fpe_using_surrogate.php | 133 +++++++++++++++
dlp/src/reidentify_table_fpe.php | 153 +++++++++++++++++
dlp/src/reidentify_text_fpe.php | 128 ++++++++++++++
dlp/test/data/fpe_input.csv | 4 +
dlp/test/dlpTest.php | 117 +++++++++++++
9 files changed, 1072 insertions(+)
create mode 100644 dlp/src/deidentify_deterministic.php
create mode 100644 dlp/src/deidentify_free_text_with_fpe_using_surrogate.php
create mode 100644 dlp/src/deidentify_table_fpe.php
create mode 100644 dlp/src/reidentify_deterministic.php
create mode 100644 dlp/src/reidentify_free_text_with_fpe_using_surrogate.php
create mode 100644 dlp/src/reidentify_table_fpe.php
create mode 100644 dlp/src/reidentify_text_fpe.php
create mode 100644 dlp/test/data/fpe_input.csv
diff --git a/dlp/src/deidentify_deterministic.php b/dlp/src/deidentify_deterministic.php
new file mode 100644
index 0000000000..29bf72f33b
--- /dev/null
+++ b/dlp/src/deidentify_deterministic.php
@@ -0,0 +1,126 @@
+setValue($inputString);
+
+ // Specify an encrypted AES-256 key and the name of the Cloud KMS key that encrypted it.
+ $kmsWrappedCryptoKey = (new KmsWrappedCryptoKey())
+ ->setWrappedKey(base64_decode($wrappedAesKey))
+ ->setCryptoKeyName($kmsKeyName);
+
+ $cryptoKey = (new CryptoKey())
+ ->setKmsWrapped($kmsWrappedCryptoKey);
+
+ // Specify how the info from the inspection should be encrypted.
+ $cryptoDeterministicConfig = (new CryptoDeterministicConfig())
+ ->setCryptoKey($cryptoKey);
+
+ if (!empty($surrogateTypeName)) {
+ $cryptoDeterministicConfig = $cryptoDeterministicConfig->setSurrogateInfoType((new InfoType())
+ ->setName($surrogateTypeName));
+ }
+
+ // Specify the type of info the inspection will look for.
+ $infoType = (new InfoType())
+ ->setName($infoTypeName);
+
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$infoType]);
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoDeterministicConfig($cryptoDeterministicConfig);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Send the request and receive response from the service.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content,
+ 'inspectConfig' => $inspectConfig
+
+ ]);
+
+ // Print the results.
+ printf($response->getItem()->getValue());
+}
+# [END dlp_deidentify_deterministic]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_free_text_with_fpe_using_surrogate.php b/dlp/src/deidentify_free_text_with_fpe_using_surrogate.php
new file mode 100644
index 0000000000..11f175abfe
--- /dev/null
+++ b/dlp/src/deidentify_free_text_with_fpe_using_surrogate.php
@@ -0,0 +1,133 @@
+setKey(base64_decode($unwrappedKey));
+
+ $cryptoKey = (new CryptoKey())
+ ->setUnwrapped($unwrapped);
+
+ // Create the surrogate type configuration object.
+ $surrogateType = (new InfoType())
+ ->setName($surrogateTypeName);
+
+ // The set of characters to replace sensitive ones with.
+ // For more information, see https://cloud.google.com/dlp/docs/reference/rest/V2/organizations.deidentifyTemplates#ffxcommonnativealphabet
+ $commonAlphabet = FfxCommonNativeAlphabet::NUMERIC;
+
+ // Specify how to decrypt the previously de-identified information.
+ $cryptoReplaceFfxFpeConfig = (new CryptoReplaceFfxFpeConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setCommonAlphabet($commonAlphabet)
+ ->setSurrogateInfoType($surrogateType);
+
+ // Create the information transform configuration objects.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoReplaceFfxFpeConfig($cryptoReplaceFfxFpeConfig);
+
+ // The infoTypes of information to mask.
+ $infoType = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $infoTypes = [$infoType];
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes($infoTypes);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the deidentification configuration object.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Specify the content to be de-identify.
+ $content = (new ContentItem())
+ ->setValue($string);
+
+ // Create the configuration object.
+ $inspectConfig = (new InspectConfig())
+ /* Construct the inspect config, trying to finding all PII with likelihood
+ higher than UNLIKELY */
+ ->setMinLikelihood(likelihood::UNLIKELY)
+ ->setInfoTypes($infoTypes);
+
+ // Run request.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content,
+ 'inspectConfig' => $inspectConfig
+ ]);
+
+ // Print the results.
+ printf($response->getItem()->getValue());
+}
+# [END dlp_deidentify_free_text_with_fpe_using_surrogate]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_fpe.php b/dlp/src/deidentify_table_fpe.php
new file mode 100644
index 0000000000..7bcdc5ca64
--- /dev/null
+++ b/dlp/src/deidentify_table_fpe.php
@@ -0,0 +1,156 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify the content to be de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify an encrypted AES-256 key and the name of the Cloud KMS key that encrypted it.
+ $kmsWrappedCryptoKey = (new KmsWrappedCryptoKey())
+ ->setWrappedKey(base64_decode($wrappedAesKey))
+ ->setCryptoKeyName($kmsKeyName);
+
+ $cryptoKey = (new CryptoKey())
+ ->setKmsWrapped($kmsWrappedCryptoKey);
+
+ // Specify how the content should be encrypted.
+ $cryptoReplaceFfxFpeConfig = (new CryptoReplaceFfxFpeConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setCommonAlphabet(FfxCommonNativeAlphabet::NUMERIC);
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoReplaceFfxFpeConfig($cryptoReplaceFfxFpeConfig);
+
+ // Specify field to be encrypted.
+ $encryptedFields = array_map(function ($encryptedFieldName) {
+ return (new FieldId())
+ ->setName($encryptedFieldName);
+ }, explode(',', $encryptedFieldNames));
+
+ // Associate the encryption with the specified field.
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields($encryptedFields);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after format-preserving encryption (File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_fpe]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/reidentify_deterministic.php b/dlp/src/reidentify_deterministic.php
new file mode 100644
index 0000000000..bda8310e93
--- /dev/null
+++ b/dlp/src/reidentify_deterministic.php
@@ -0,0 +1,122 @@
+setValue($string);
+
+ // Specify the surrogate type used at time of de-identification.
+ $surrogateType = (new InfoType())
+ ->setName($surrogateTypeName);
+
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($surrogateType)
+ ->setSurrogateType(new SurrogateType());
+
+ // Create the inspect configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType]);
+
+ // Specify an encrypted AES-256 key and the name of the Cloud KMS key that encrypted it.
+ $kmsWrappedCryptoKey = (new KmsWrappedCryptoKey())
+ ->setWrappedKey(base64_decode($wrappedKey))
+ ->setCryptoKeyName($keyName);
+
+ // Create the crypto key configuration object.
+ $cryptoKey = (new CryptoKey())
+ ->setKmsWrapped($kmsWrappedCryptoKey);
+
+ // Create the crypto deterministic configuration object.
+ $cryptoDeterministicConfig = (new CryptoDeterministicConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setSurrogateInfoType($surrogateType);
+
+ // Create the information transform configuration objects.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoDeterministicConfig($cryptoDeterministicConfig);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the reidentification configuration object.
+ $reidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Run request.
+ $response = $dlp->reidentifyContent($parent, [
+ 'reidentifyConfig' => $reidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ printf($response->getItem()->getValue());
+}
+# [END dlp_reidentify_deterministic]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/reidentify_free_text_with_fpe_using_surrogate.php b/dlp/src/reidentify_free_text_with_fpe_using_surrogate.php
new file mode 100644
index 0000000000..31c92d6c5e
--- /dev/null
+++ b/dlp/src/reidentify_free_text_with_fpe_using_surrogate.php
@@ -0,0 +1,133 @@
+setKey(base64_decode($unwrappedKey));
+
+ $cryptoKey = (new CryptoKey())
+ ->setUnwrapped($unwrapped);
+
+ // Specify the surrogate type used at time of de-identification.
+ $surrogateType = (new InfoType())
+ ->setName($surrogateTypeName);
+
+ // The set of characters to replace sensitive ones with.
+ // For more information, see https://cloud.google.com/dlp/docs/reference/rest/V2/organizations.deidentifyTemplates#ffxcommonnativealphabet
+ $commonAlphabet = FfxCommonNativeAlphabet::NUMERIC;
+
+ // Specify how to decrypt the previously de-identified information.
+ $cryptoReplaceFfxFpeConfig = (new CryptoReplaceFfxFpeConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setCommonAlphabet($commonAlphabet)
+ ->setSurrogateInfoType($surrogateType);
+
+ // Create the information transform configuration objects.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoReplaceFfxFpeConfig($cryptoReplaceFfxFpeConfig);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the reidentification configuration object.
+ $reidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Create the inspect configuration object.
+ // Specify the type of info the inspection will look for.
+ $infotype = (new InfoType())
+ ->setName($surrogateTypeName);
+
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($infotype)
+ ->setSurrogateType((new SurrogateType()));
+
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType]);
+
+ // Specify the content to be re-identify.
+ $content = (new ContentItem())
+ ->setValue($string);
+
+ // Run request.
+ $response = $dlp->reidentifyContent($parent, [
+ 'reidentifyConfig' => $reidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results.
+ printf($response->getItem()->getValue());
+}
+# [END dlp_reidentify_free_text_with_fpe_using_surrogate]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/reidentify_table_fpe.php b/dlp/src/reidentify_table_fpe.php
new file mode 100644
index 0000000000..1ab3d9598d
--- /dev/null
+++ b/dlp/src/reidentify_table_fpe.php
@@ -0,0 +1,153 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify the content to be reidentify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify an encrypted AES-256 key and the name of the Cloud KMS key that encrypted it.
+ $kmsWrappedCryptoKey = (new KmsWrappedCryptoKey())
+ ->setWrappedKey(base64_decode($wrappedAesKey))
+ ->setCryptoKeyName($kmsKeyName);
+
+ $cryptoKey = (new CryptoKey())
+ ->setKmsWrapped($kmsWrappedCryptoKey);
+
+ // Specify how to un-encrypt the previously de-identified information.
+ $cryptoReplaceFfxFpeConfig = (new CryptoReplaceFfxFpeConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setCommonAlphabet(FfxCommonNativeAlphabet::NUMERIC);
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoReplaceFfxFpeConfig($cryptoReplaceFfxFpeConfig);
+
+ // Specify field to be decrypted.
+ $encryptedFields = array_map(function ($encryptedFieldName) {
+ return (new FieldId())
+ ->setName($encryptedFieldName);
+ }, explode(',', $encryptedFieldNames));
+
+ // Associate the decryption with the specified field.
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields($encryptedFields);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ $reidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Run request.
+ $response = $dlp->reidentifyContent($parent, [
+ 'reidentifyConfig' => $reidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after re-identification (File Location): %s', $outputCsvFile);
+}
+# [END dlp_reidentify_table_fpe]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/reidentify_text_fpe.php b/dlp/src/reidentify_text_fpe.php
new file mode 100644
index 0000000000..9447adb773
--- /dev/null
+++ b/dlp/src/reidentify_text_fpe.php
@@ -0,0 +1,128 @@
+setValue($string);
+
+ // Specify the type of info the inspection will re-identify. This must use the same custom
+ // into type that was used as a surrogate during the initial encryption.
+ $surrogateType = (new InfoType())
+ ->setName($surrogateTypeName);
+
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType($surrogateType)
+ ->setSurrogateType(new SurrogateType());
+
+ // Create the inspect configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType]);
+
+ // Set of characters in the input text. For more info, see
+ // https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#DeidentifyTemplate.FfxCommonNativeAlphabet
+ $commonAlphabet = FfxCommonNativeAlphabet::NUMERIC;
+
+ // Specify an encrypted AES-256 key and the name of the Cloud KMS key that encrypted it.
+ $kmsWrappedCryptoKey = (new KmsWrappedCryptoKey())
+ ->setWrappedKey(base64_decode($wrappedKey))
+ ->setCryptoKeyName($keyName);
+
+ // Create the crypto key configuration object.
+ $cryptoKey = (new CryptoKey())
+ ->setKmsWrapped($kmsWrappedCryptoKey);
+
+ // Specify how to un-encrypt the previously de-identified information.
+ $cryptoReplaceFfxFpeConfig = (new CryptoReplaceFfxFpeConfig())
+ ->setCryptoKey($cryptoKey)
+ ->setCommonAlphabet($commonAlphabet)
+ ->setSurrogateInfoType($surrogateType);
+
+ // Create the information transform configuration objects.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoReplaceFfxFpeConfig($cryptoReplaceFfxFpeConfig);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the reidentification configuration object.
+ $reidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Run request.
+ $response = $dlp->reidentifyContent($parent, [
+ 'reidentifyConfig' => $reidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ printf($response->getItem()->getValue());
+}
+# [END dlp_reidentify_text_fpe]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/data/fpe_input.csv b/dlp/test/data/fpe_input.csv
new file mode 100644
index 0000000000..af19b890c8
--- /dev/null
+++ b/dlp/test/data/fpe_input.csv
@@ -0,0 +1,4 @@
+EmployeeID,DATE,Compensation
+11111,2015,$10
+11111,2016,$20
+22222,2016,$15
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index d4637ef28c..f29c32d7d6 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -655,6 +655,123 @@ public function testInspectTable()
$this->assertStringNotContainsString('Info type: PERSON_NAME', $output);
}
+ public function testDeidReidFPEUsingSurrogate()
+ {
+ $unwrappedKey = 'YWJjZGVmZ2hpamtsbW5vcA==';
+ $string = 'My PHONE NUMBER IS 7319976811';
+ $surrogateTypeName = 'PHONE_TOKEN';
+
+ $deidOutput = $this->runFunctionSnippet('deidentify_free_text_with_fpe_using_surrogate', [
+ self::$projectId,
+ $string,
+ $unwrappedKey,
+ $surrogateTypeName,
+ ]);
+ $this->assertMatchesRegularExpression('/My PHONE NUMBER IS PHONE_TOKEN\(\d+\):\d+/', $deidOutput);
+
+ $reidOutput = $this->runFunctionSnippet('reidentify_free_text_with_fpe_using_surrogate', [
+ self::$projectId,
+ $deidOutput,
+ $unwrappedKey,
+ $surrogateTypeName,
+ ]);
+ $this->assertEquals($string, $reidOutput);
+ }
+
+ public function testDeIdentifyTableFpe()
+ {
+ $inputCsvFile = __DIR__ . '/data/fpe_input.csv';
+ $outputCsvFile = __DIR__ . '/data/fpe_output_unittest.csv';
+ $outputCsvFile2 = __DIR__ . '/data/reidentify_fpe_ouput_unittest.csv';
+ $encryptedFieldNames = 'EmployeeID';
+ $keyName = $this->requireEnv('DLP_DEID_KEY_NAME');
+ $wrappedKey = $this->requireEnv('DLP_DEID_WRAPPED_KEY');
+
+ $output = $this->runFunctionSnippet('deidentify_table_fpe', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile,
+ $encryptedFieldNames,
+ $keyName,
+ $wrappedKey,
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $output = $this->runFunctionSnippet('reidentify_table_fpe', [
+ self::$projectId,
+ $outputCsvFile,
+ $outputCsvFile2,
+ $encryptedFieldNames,
+ $keyName,
+ $wrappedKey,
+ ]);
+
+ $this->assertEquals(
+ sha1_file($inputCsvFile),
+ sha1_file($outputCsvFile2)
+ );
+ unlink($outputCsvFile);
+ unlink($outputCsvFile2);
+ }
+
+ public function testDeidReidDeterministic()
+ {
+ $inputString = 'My PHONE NUMBER IS 731997681';
+ $infoTypeName = 'PHONE_NUMBER';
+ $surrogateTypeName = 'PHONE_TOKEN';
+ $keyName = $this->requireEnv('DLP_DEID_KEY_NAME');
+ $wrappedKey = $this->requireEnv('DLP_DEID_WRAPPED_KEY');
+
+ $deidOutput = $this->runFunctionSnippet('deidentify_deterministic', [
+ self::$projectId,
+ $keyName,
+ $wrappedKey,
+ $inputString,
+ $infoTypeName,
+ $surrogateTypeName
+ ]);
+ $this->assertMatchesRegularExpression('/My PHONE NUMBER IS PHONE_TOKEN\(\d+\):\(\w|\/|=|\)+/', $deidOutput);
+
+ $reidOutput = $this->runFunctionSnippet('reidentify_deterministic', [
+ self::$projectId,
+ $deidOutput,
+ $surrogateTypeName,
+ $keyName,
+ $wrappedKey,
+ ]);
+ $this->assertEquals($inputString, $reidOutput);
+ }
+
+ public function testDeidReidTextFPE()
+ {
+ $string = 'My SSN is 372819127';
+ $keyName = $this->requireEnv('DLP_DEID_KEY_NAME');
+ $wrappedKey = $this->requireEnv('DLP_DEID_WRAPPED_KEY');
+ $surrogateType = 'SSN_TOKEN';
+
+ $deidOutput = $this->runFunctionSnippet('deidentify_fpe', [
+ self::$projectId,
+ $string,
+ $keyName,
+ $wrappedKey,
+ $surrogateType,
+ ]);
+ $this->assertMatchesRegularExpression('/My SSN is SSN_TOKEN\(\d+\):\d+/', $deidOutput);
+
+ $reidOutput = $this->runFunctionSnippet('reidentify_text_fpe', [
+ self::$projectId,
+ $deidOutput,
+ $keyName,
+ $wrappedKey,
+ $surrogateType,
+ ]);
+ $this->assertEquals($string, $reidOutput);
+ }
+
public function testGetJob()
{
From 0d8f29db07350711a8321f1a822d33ffccffd2fb Mon Sep 17 00:00:00 2001
From: Vishwaraj Anand
Date: Wed, 21 Jun 2023 23:17:13 +0000
Subject: [PATCH 036/285] feat(Spanner): add sample for update database (#1793)
---
spanner/composer.json | 2 +-
spanner/src/update_database.php | 61 +++++++++++++++++++++++++++++++++
spanner/test/spannerTest.php | 22 ++++++++++++
3 files changed, 84 insertions(+), 1 deletion(-)
create mode 100644 spanner/src/update_database.php
diff --git a/spanner/composer.json b/spanner/composer.json
index 109f502236..3680820374 100755
--- a/spanner/composer.json
+++ b/spanner/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-spanner": "^1.54.0"
+ "google/cloud-spanner": "^1.62.1"
}
}
diff --git a/spanner/src/update_database.php b/spanner/src/update_database.php
new file mode 100644
index 0000000000..4c90059055
--- /dev/null
+++ b/spanner/src/update_database.php
@@ -0,0 +1,61 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+ printf(
+ 'Updating database %s',
+ $database->name(),
+ );
+ $op = $database->updateDatabase(['enableDropProtection' => true]);
+ $op->pollUntilComplete();
+ $database->reload();
+ printf(
+ 'Updated the drop protection for %s to %s' . PHP_EOL,
+ $database->name(),
+ $database->info()['enableDropProtection']
+ );
+}
+// [END spanner_update_database]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php
index cfd5f0cb92..d1eb54a135 100644
--- a/spanner/test/spannerTest.php
+++ b/spanner/test/spannerTest.php
@@ -239,6 +239,28 @@ public function testCreateDatabaseWithEncryptionKey()
$this->assertStringContainsString('Created database en-test-', $output);
}
+ /**
+ * @depends testCreateDatabase
+ */
+ public function testUpdateDatabase()
+ {
+ $output = $this->runFunctionSnippet('update_database', [
+ 'instanceId' => self::$instanceId,
+ 'databaseId' => self::$databaseId
+ ]);
+ $this->assertStringContainsString(self::$databaseId, $output);
+ $this->assertStringContainsString(true, $output);
+
+ // reset the enableDropProtection for test tear down
+ $spanner = new SpannerClient();
+ $instance = $spanner->instance(self::$instanceId);
+ $database = $instance->database(self::$databaseId);
+ $op = $database->updateDatabase(['enableDropProtection' => false]);
+ $op->pollUntilComplete();
+ $database->reload();
+ $this->assertFalse($database->info()['enableDropProtection']);
+ }
+
/**
* @depends testCreateDatabase
*/
From b51e7fdfeaf6ee88be21dce88ee4fa268dc32801 Mon Sep 17 00:00:00 2001
From: Yash Sahu <54198301+yash30201@users.noreply.github.com>
Date: Fri, 23 Jun 2023 11:30:17 +0530
Subject: [PATCH 037/285] chore(Spanner): Update batch_query_data sample
(#1853)
Update the `batch_query_data` sample to show the usage of `dataBoostEnabled` option for partition query
---
spanner/src/batch_query_data.php | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/spanner/src/batch_query_data.php b/spanner/src/batch_query_data.php
index e7c7b6490d..4188320d27 100644
--- a/spanner/src/batch_query_data.php
+++ b/spanner/src/batch_query_data.php
@@ -42,7 +42,12 @@ function batch_query_data(string $instanceId, string $databaseId): void
$batch = $spanner->batch($instanceId, $databaseId);
$snapshot = $batch->snapshot();
$queryString = 'SELECT SingerId, FirstName, LastName FROM Singers';
- $partitions = $snapshot->partitionQuery($queryString);
+ $partitions = $snapshot->partitionQuery($queryString, [
+ // This is an optional parameter which can be used for partition
+ // read and query to execute the request via spanner independent
+ // compute resources.
+ 'dataBoostEnabled' => true
+ ]);
$totalPartitions = count($partitions);
$totalRecords = 0;
foreach ($partitions as $partition) {
From 1d14847bc27a0f563659b54f9d4f8ae6549db4d3 Mon Sep 17 00:00:00 2001
From: Vishwaraj Anand
Date: Fri, 23 Jun 2023 10:17:49 +0000
Subject: [PATCH 038/285] chore: remove dollar outside curly braces (#1840)
---
appengine/flexible/drupal8/test/DeployTest.php | 17 +++++++++++------
.../laravel/test/DeployDatabaseSessionTest.php | 2 +-
appengine/flexible/symfony/test/DeployTest.php | 5 +++--
appengine/standard/getting-started/src/app.php | 2 +-
.../getting-started/test/CloudSqlTest.php | 6 +++---
cloud_sql/mysql/pdo/test/IntegrationTest.php | 2 +-
cloud_sql/postgres/pdo/test/IntegrationTest.php | 2 +-
7 files changed, 21 insertions(+), 15 deletions(-)
diff --git a/appengine/flexible/drupal8/test/DeployTest.php b/appengine/flexible/drupal8/test/DeployTest.php
index 5fd519d343..73d113ab98 100644
--- a/appengine/flexible/drupal8/test/DeployTest.php
+++ b/appengine/flexible/drupal8/test/DeployTest.php
@@ -57,7 +57,7 @@ private static function verifyEnvironmentVariables()
];
foreach ($envVars as $envVar) {
if (false === getenv($envVar)) {
- self::markTestSkipped("Please set the ${envVar} environment variable");
+ self::markTestSkipped("Please set the {$envVar} environment variable");
}
}
}
@@ -66,7 +66,8 @@ private static function downloadAndInstallDrupal($targetDir)
{
$console = __DIR__ . '/../vendor/bin/drush';
- $dbUrl = sprintf('mysql://%s:%s@%s/%s',
+ $dbUrl = sprintf(
+ 'mysql://%s:%s@%s/%s',
getenv('DRUPAL8_DATABASE_USER'),
getenv('DRUPAL8_DATABASE_PASS'),
getenv('DRUPAL8_DATABASE_HOST'),
@@ -75,19 +76,23 @@ private static function downloadAndInstallDrupal($targetDir)
// download
self::setWorkingDirectory(dirname($targetDir));
- $downloadCmd = sprintf('%s dl drupal --drupal-project-rename=%s',
+ $downloadCmd = sprintf(
+ '%s dl drupal --drupal-project-rename=%s',
$console,
- basename($targetDir));
+ basename($targetDir)
+ );
self::execute($downloadCmd);
// install
self::setWorkingDirectory($targetDir);
- $installCmd = sprintf('%s site-install standard ' .
+ $installCmd = sprintf(
+ '%s site-install standard ' .
'--db-url=%s --account-name=%s --account-pass=%s -y',
$console,
$dbUrl,
getenv('DRUPAL8_ADMIN_USERNAME'),
- getenv('DRUPAL8_ADMIN_PASSWORD'));
+ getenv('DRUPAL8_ADMIN_PASSWORD')
+ );
$process = self::createProcess($installCmd);
$process->setTimeout(null);
self::executeProcess($process);
diff --git a/appengine/flexible/laravel/test/DeployDatabaseSessionTest.php b/appengine/flexible/laravel/test/DeployDatabaseSessionTest.php
index 56e34362ec..90fd981c61 100644
--- a/appengine/flexible/laravel/test/DeployDatabaseSessionTest.php
+++ b/appengine/flexible/laravel/test/DeployDatabaseSessionTest.php
@@ -58,7 +58,7 @@ private static function verifyEnvironmentVariables()
];
foreach ($envVars as $envVar) {
if (false === getenv($envVar)) {
- self::fail("Please set the ${envVar} environment variable");
+ self::fail("Please set the {$envVar} environment variable");
}
}
}
diff --git a/appengine/flexible/symfony/test/DeployTest.php b/appengine/flexible/symfony/test/DeployTest.php
index a75c918501..118278df2d 100644
--- a/appengine/flexible/symfony/test/DeployTest.php
+++ b/appengine/flexible/symfony/test/DeployTest.php
@@ -61,7 +61,7 @@ private static function verifyEnvironmentVariables()
];
foreach ($envVars as $envVar) {
if (false === getenv($envVar)) {
- self::fail("Please set the ${envVar} environment variable");
+ self::fail("Please set the {$envVar} environment variable");
}
}
}
@@ -161,6 +161,7 @@ function () use ($logger, $path) {
}
}
$this->assertTrue($found, 'The log entry was not found');
- });
+ }
+ );
}
}
diff --git a/appengine/standard/getting-started/src/app.php b/appengine/standard/getting-started/src/app.php
index 9864d8013f..03897d3e2f 100644
--- a/appengine/standard/getting-started/src/app.php
+++ b/appengine/standard/getting-started/src/app.php
@@ -69,7 +69,7 @@
// $dbName = 'YOUR_CLOUDSQL_DATABASE_NAME';
// $dbUser = 'YOUR_CLOUDSQL_USER';
// $dbPass = 'YOUR_CLOUDSQL_PASSWORD';
- $dsn = "mysql:unix_socket=/cloudsql/${dbConn};dbname=${dbName}";
+ $dsn = "mysql:unix_socket=/cloudsql/{$dbConn};dbname={$dbName}";
$pdo = new PDO($dsn, $dbUser, $dbPass);
// [END gae_php_app_cloudsql_client_setup]
$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
diff --git a/appengine/standard/getting-started/test/CloudSqlTest.php b/appengine/standard/getting-started/test/CloudSqlTest.php
index 43886ecf0f..d9ba1dd447 100644
--- a/appengine/standard/getting-started/test/CloudSqlTest.php
+++ b/appengine/standard/getting-started/test/CloudSqlTest.php
@@ -37,14 +37,14 @@ public function setUp(): void
$dbUser = $this->requireEnv('CLOUDSQL_USER');
$dbPass = $this->requireEnv('CLOUDSQL_PASSWORD');
$dbName = getenv('CLOUDSQL_DATABASE_NAME') ?: 'bookshelf';
- $socket = "${socketDir}/${connection}";
+ $socket = "{$socketDir}/{$connection}";
if (!file_exists($socket)) {
$this->markTestSkipped(
- "You must run 'cloud_sql_proxy -instances=${connection} -dir=${socketDir}'"
+ "You must run 'cloud_sql_proxy -instances={$connection} -dir={$socketDir}'"
);
}
- $dsn = "mysql:unix_socket=${socket};dbname=${dbName}";
+ $dsn = "mysql:unix_socket={$socket};dbname={$dbName}";
$pdo = new Pdo($dsn, $dbUser, $dbPass);
$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
diff --git a/cloud_sql/mysql/pdo/test/IntegrationTest.php b/cloud_sql/mysql/pdo/test/IntegrationTest.php
index 5c4df9c2d8..deec4b27a1 100644
--- a/cloud_sql/mysql/pdo/test/IntegrationTest.php
+++ b/cloud_sql/mysql/pdo/test/IntegrationTest.php
@@ -47,7 +47,7 @@ public function testUnixConnection()
$dbUser = $this->requireEnv('MYSQL_USER');
$connectionName = $this->requireEnv('CLOUDSQL_CONNECTION_NAME_MYSQL');
$socketDir = $this->requireEnv('DB_SOCKET_DIR');
- $instanceUnixSocket = "${socketDir}/${connectionName}";
+ $instanceUnixSocket = "{$socketDir}/{$connectionName}";
putenv("DB_PASS=$dbPass");
putenv("DB_NAME=$dbName");
diff --git a/cloud_sql/postgres/pdo/test/IntegrationTest.php b/cloud_sql/postgres/pdo/test/IntegrationTest.php
index 412ae03f43..b57d8652e1 100644
--- a/cloud_sql/postgres/pdo/test/IntegrationTest.php
+++ b/cloud_sql/postgres/pdo/test/IntegrationTest.php
@@ -48,7 +48,7 @@ public function testUnixConnection()
'CLOUDSQL_CONNECTION_NAME_POSTGRES'
);
$socketDir = $this->requireEnv('DB_SOCKET_DIR');
- $instanceUnixSocket = "${socketDir}/${connectionName}";
+ $instanceUnixSocket = "{$socketDir}/{$connectionName}";
putenv("DB_PASS=$dbPass");
putenv("DB_NAME=$dbName");
From 1904e963c6f1ca28f1cdd60bcf2f62e3d009fdcb Mon Sep 17 00:00:00 2001
From: meredithslota
Date: Tue, 27 Jun 2023 10:17:04 +0000
Subject: [PATCH 039/285] chore(docs): remove archived tutorial samples (#1855)
---
appengine/standard/README.md | 1 -
appengine/standard/wordpress/.gitignore | 1 -
appengine/standard/wordpress/README.md | 3 -
appengine/standard/wordpress/composer.json | 8 ---
appengine/standard/wordpress/phpunit.xml.dist | 27 -------
.../standard/wordpress/test/DeployTest.php | 72 -------------------
appengine/wordpress/README.md | 1 -
7 files changed, 113 deletions(-)
delete mode 100644 appengine/standard/wordpress/.gitignore
delete mode 100644 appengine/standard/wordpress/README.md
delete mode 100644 appengine/standard/wordpress/composer.json
delete mode 100644 appengine/standard/wordpress/phpunit.xml.dist
delete mode 100644 appengine/standard/wordpress/test/DeployTest.php
diff --git a/appengine/standard/README.md b/appengine/standard/README.md
index 2e04c22e6e..366a8ad3cd 100644
--- a/appengine/standard/README.md
+++ b/appengine/standard/README.md
@@ -26,4 +26,3 @@
* [Laravel](laravel-framework)
* [Slim Framework](slim-framework)
* [Symfony](symfony-framework)
-* [WordPress](wordpress)
diff --git a/appengine/standard/wordpress/.gitignore b/appengine/standard/wordpress/.gitignore
deleted file mode 100644
index b13ec3f29e..0000000000
--- a/appengine/standard/wordpress/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-my-wordpress-project
diff --git a/appengine/standard/wordpress/README.md b/appengine/standard/wordpress/README.md
deleted file mode 100644
index 24ec4f7a9d..0000000000
--- a/appengine/standard/wordpress/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# WordPress on App Engine Standard for PHP 7.2
-
-Please refer to [the community tutorial](https://cloud.google.com/community/tutorials/run-wordpress-on-appengine-standard) for running the code in this sample.
diff --git a/appengine/standard/wordpress/composer.json b/appengine/standard/wordpress/composer.json
deleted file mode 100644
index 6f814f0c31..0000000000
--- a/appengine/standard/wordpress/composer.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "require": {
- "ext-phar": "*",
- "ext-zip": "*",
- "paragonie/random_compat": "^9.0.0",
- "google/cloud-tools": "dev-main"
- }
-}
diff --git a/appengine/standard/wordpress/phpunit.xml.dist b/appengine/standard/wordpress/phpunit.xml.dist
deleted file mode 100644
index 7918979bd3..0000000000
--- a/appengine/standard/wordpress/phpunit.xml.dist
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
-
-
-
- test
- ./vendor
-
-
-
-
-
-
diff --git a/appengine/standard/wordpress/test/DeployTest.php b/appengine/standard/wordpress/test/DeployTest.php
deleted file mode 100644
index 25df24b9cb..0000000000
--- a/appengine/standard/wordpress/test/DeployTest.php
+++ /dev/null
@@ -1,72 +0,0 @@
- $dir,
- '--project_id' => $projectId,
- '--db_instance' => $dbInstance,
- '--db_user' => $dbUser,
- '--db_password' => $dbPassword,
- '--db_name' => getenv('WORDPRESS_DB_NAME') ?: 'wordpress_php72',
- ]);
-
- self::$gcloudWrapper->setDir($dir);
- }
-
- public function testIndex()
- {
- $this->markTestSkipped(
- 'This sample is BROKEN. See https://github.com/GoogleCloudPlatform/php-docs-samples/issues/1348'
- );
-
- // Access the blog top page
- $resp = $this->client->get('');
- $this->assertEquals('200', $resp->getStatusCode());
- $this->assertStringContainsString(
- 'It looks like your WordPress installation is running on App '
- . 'Engine for PHP 7.2!',
- $resp->getBody()->getContents()
- );
- }
-}
diff --git a/appengine/wordpress/README.md b/appengine/wordpress/README.md
index f015758b48..c767801633 100644
--- a/appengine/wordpress/README.md
+++ b/appengine/wordpress/README.md
@@ -6,5 +6,4 @@ This is a list of samples which contain a CLI tool for deploying WordPress to Ap
|Runtime|Description|
|---|---|
-|[App Engine Standard](../standard/wordpress) (**Recommended!**)|The latest App Engine Runtime, and the latest version of PHP!|
|[App Engine Flexible Environment](../flexible/wordpress)|Longer deployments, but allows for custom containers using Docker. Use this only if you're certain you need these features.|
From 33c0805694357758ae60b0e85c85460552fd95df Mon Sep 17 00:00:00 2001
From: janell-chen <122311137+janell-chen@users.noreply.github.com>
Date: Wed, 28 Jun 2023 11:17:23 -0600
Subject: [PATCH 040/285] Add sample for functions : Response streaming (#1854)
* Add response streaming sample in PHP
* Remove test
* Add unit test
* Add region tags
* Address comments
* lint fix
* fix lint
---
functions/response_streaming/composer.json | 6 ++
functions/response_streaming/index.php | 42 ++++++++++++++
functions/response_streaming/phpunit.xml.dist | 34 ++++++++++++
.../response_streaming/test/UnitTest.php | 55 +++++++++++++++++++
4 files changed, 137 insertions(+)
create mode 100644 functions/response_streaming/composer.json
create mode 100644 functions/response_streaming/index.php
create mode 100644 functions/response_streaming/phpunit.xml.dist
create mode 100644 functions/response_streaming/test/UnitTest.php
diff --git a/functions/response_streaming/composer.json b/functions/response_streaming/composer.json
new file mode 100644
index 0000000000..6fdc342928
--- /dev/null
+++ b/functions/response_streaming/composer.json
@@ -0,0 +1,6 @@
+{
+ "require": {
+ "google/cloud-functions-framework": "^1.1",
+ "google/cloud-bigquery": "^1.24"
+ }
+}
diff --git a/functions/response_streaming/index.php b/functions/response_streaming/index.php
new file mode 100644
index 0000000000..b1ce5b8c99
--- /dev/null
+++ b/functions/response_streaming/index.php
@@ -0,0 +1,42 @@
+ $projectId]);
+ $queryJobConfig = $bigQuery->query(
+ 'SELECT abstract FROM `bigquery-public-data.breathe.bioasq` LIMIT 1000'
+ );
+ $queryResults = $bigQuery->runQuery($queryJobConfig);
+
+ // Stream out large payload by iterating rows and flushing output.
+ foreach ($queryResults as $row) {
+ foreach ($row as $column => $value) {
+ printf('%s' . PHP_EOL, json_encode($value));
+ flush();
+ }
+ }
+ printf('Successfully streamed rows');
+}
+// [END functions_response_streaming]
diff --git a/functions/response_streaming/phpunit.xml.dist b/functions/response_streaming/phpunit.xml.dist
new file mode 100644
index 0000000000..b93dfd88c7
--- /dev/null
+++ b/functions/response_streaming/phpunit.xml.dist
@@ -0,0 +1,34 @@
+
+
+
+
+
+ test
+
+
+
+
+
+
+
+ .
+
+ ./vendor
+
+
+
+
diff --git a/functions/response_streaming/test/UnitTest.php b/functions/response_streaming/test/UnitTest.php
new file mode 100644
index 0000000000..1f76422590
--- /dev/null
+++ b/functions/response_streaming/test/UnitTest.php
@@ -0,0 +1,55 @@
+runFunction(self::$entryPoint, [$request]);
+ $result = ob_get_clean();
+ $this->assertStringContainsString('Successfully streamed rows', $result);
+ }
+
+ private static function runFunction($functionName, array $params = []): void
+ {
+ call_user_func_array($functionName, $params);
+ }
+}
From 3af3c8ef7292b272adc76b646dabfdde6f943450 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Sat, 1 Jul 2023 10:58:55 -0700
Subject: [PATCH 041/285] Upgrade endpoints samples (#1862)
* chore: upgrade endpoints samples to new format
* fix: upgrade endpoints samples to new format
---------
Co-authored-by: Vishwaraj Anand
---
.../getting-started/EndpointsCommand.php | 141 ------------------
endpoints/getting-started/README.md | 8 +-
endpoints/getting-started/composer.json | 1 -
endpoints/getting-started/endpoints.php | 27 ----
.../getting-started/src/make_request.php | 113 ++++++++++++++
...ointsCommandTest.php => endpointsTest.php} | 54 ++-----
6 files changed, 133 insertions(+), 211 deletions(-)
delete mode 100644 endpoints/getting-started/EndpointsCommand.php
delete mode 100644 endpoints/getting-started/endpoints.php
create mode 100644 endpoints/getting-started/src/make_request.php
rename endpoints/getting-started/test/{EndpointsCommandTest.php => endpointsTest.php} (58%)
diff --git a/endpoints/getting-started/EndpointsCommand.php b/endpoints/getting-started/EndpointsCommand.php
deleted file mode 100644
index bb3ee53117..0000000000
--- a/endpoints/getting-started/EndpointsCommand.php
+++ /dev/null
@@ -1,141 +0,0 @@
-setName('make-request')
- ->setDescription('Send in a request to endpoints')
- ->addArgument(
- 'host',
- InputArgument::REQUIRED,
- 'Your API host, e.g. https://your-project.appspot.com.'
- )
- ->addArgument(
- 'api_key',
- InputArgument::REQUIRED,
- 'Your API key.'
- )
- ->addArgument(
- 'credentials',
- InputArgument::OPTIONAL,
- 'The path to your credentials file. This can be service account credentials, client secrets, or omitted.'
- )
- ->addOption(
- 'message',
- 'm',
- InputOption::VALUE_REQUIRED,
- 'The message to send in',
- 'TEST MESSAGE (change this with -m)'
- );
- }
-
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $api_key = $input->getArgument('api_key');
- $host = $input->getArgument('host');
- $message = $input->getOption('message');
-
- $http = new HttpClient(['base_uri' => $host]);
- $headers = [];
- $body = null;
-
- if ($credentials = $input->getArgument('credentials')) {
- if (!file_exists($credentials)) {
- throw new InvalidArgumentException('file does not exist');
- }
- if (!$config = json_decode(file_get_contents($credentials), true)) {
- throw new LogicException('invalid json for auth config');
- }
-
- $oauth = new OAuth2([
- 'issuer' => 'jwt-client.endpoints.sample.google.com',
- 'audience' => 'echo.endpoints.sample.google.com',
- 'scope' => 'email',
- 'authorizationUri' => 'https://accounts.google.com/o/oauth2/auth',
- 'tokenCredentialUri' => 'https://www.googleapis.com/oauth2/v4/token',
- ]);
-
- if (isset($config['type']) && $config['type'] == 'service_account') {
- // return the "jwt" info from the request
- $method = 'GET';
- $path = '/auth/info/googlejwt';
-
- $oauth->setSub('123456');
- $oauth->setSigningKey($config['private_key']);
- $oauth->setSigningAlgorithm('RS256');
- $oauth->setClientId($config['client_id']);
- $jwt = $oauth->toJwt();
-
- $headers['Authorization'] = sprintf('Bearer %s', $jwt);
- } else {
- // return the "idtoken" info from the request
- $method = 'GET';
- $path = '/auth/info/googleidtoken';
-
- // open the URL
- $oauth->setClientId($config['installed']['client_id']);
- $oauth->setClientSecret($config['installed']['client_secret']);
- $oauth->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
- $authUrl = $oauth->buildFullAuthorizationUri(['access_type' => 'offline']);
- `open '$authUrl'`;
-
- // prompt for the auth code
- $q = new Question('Please enter the authorization code:');
- $helper = new QuestionHelper();
- $authCode = $helper->ask($input, $output, $q);
- $oauth->setCode($authCode);
-
- $token = $oauth->fetchAuthToken();
- if (empty($token['id_token'])) {
- return $output->writeln('unable to retrieve ID token');
- }
- $headers['Authorization'] = sprintf('Bearer %s', $token['id_token']);
- }
- } else {
- // return just the message we sent in
- $method = 'POST';
- $path = '/echo';
- $body = json_encode([ 'message' => $message ]);
- $headers['Content-Type'] = 'application/json';
- }
-
- $output->writeln(sprintf('requesting "%s"...', $path));
-
- $response = $http->request($method, $path, [
- 'query' => ['key' => $api_key],
- 'body' => $body,
- 'headers' => $headers
- ]);
-
- $output->writeln((string) $response->getBody());
- }
-}
diff --git a/endpoints/getting-started/README.md b/endpoints/getting-started/README.md
index 751dc77638..931bb4b9b5 100644
--- a/endpoints/getting-started/README.md
+++ b/endpoints/getting-started/README.md
@@ -27,7 +27,7 @@ Run the application:
With the app running locally, you can execute the simple echo client using:
- $ php endpoints.php make-request http://localhost:8080 APIKEY
+ $ php src/make_request.php http://localhost:8080 APIKEY
The `APIKEY` can be any string as the local endpoint proxy doesn't need authentication.
@@ -47,7 +47,7 @@ With the project deployed, you'll need to create an API key to access the API.
With the API key, you can use the echo client to access the API:
- $ php endpoints.php make-request https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY
+ $ php src/make_request.php https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY
### Using the JWT client.
@@ -80,7 +80,7 @@ To use the service account for authentication:
Now you can use the JWT client to make requests to the API:
- $ php endpoints.php make-request https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY /path/to/service-account.json
+ $ php src/make_request.php https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY /path/to/service-account.json
### Using the ID Token client.
@@ -110,7 +110,7 @@ To use the client ID for authentication:
Now you can use the client ID to make requests to the API:
- $ php endpoints.php make-request https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY /path/to/client-secrets.json
+ $ php src/make_request.php https://YOUR-PROJECT-ID.appspot.com YOUR-API-KEY /path/to/client-secrets.json
If you experience any issues, try running `gcloud endpoints configs describe` to
diff --git a/endpoints/getting-started/composer.json b/endpoints/getting-started/composer.json
index 86d5c9622c..ad14e1a189 100644
--- a/endpoints/getting-started/composer.json
+++ b/endpoints/getting-started/composer.json
@@ -2,7 +2,6 @@
"require": {
"slim/slim": "^4.7",
"slim/psr7": "^1.3",
- "symfony/console": " ^5.0",
"google/auth": "^1.8.0"
},
"autoload": {
diff --git a/endpoints/getting-started/endpoints.php b/endpoints/getting-started/endpoints.php
deleted file mode 100644
index c90712079e..0000000000
--- a/endpoints/getting-started/endpoints.php
+++ /dev/null
@@ -1,27 +0,0 @@
-#!/usr/bin/env php
-add($command);
-$application->run();
diff --git a/endpoints/getting-started/src/make_request.php b/endpoints/getting-started/src/make_request.php
new file mode 100644
index 0000000000..43eeda4e25
--- /dev/null
+++ b/endpoints/getting-started/src/make_request.php
@@ -0,0 +1,113 @@
+ $host]);
+ $headers = [];
+ $body = null;
+
+ if ($credentials) {
+ if (!file_exists($credentials)) {
+ throw new \InvalidArgumentException('file does not exist');
+ }
+ if (!$config = json_decode(file_get_contents($credentials), true)) {
+ throw new \LogicException('invalid json for auth config');
+ }
+
+ $oauth = new OAuth2([
+ 'issuer' => 'jwt-client.endpoints.sample.google.com',
+ 'audience' => 'echo.endpoints.sample.google.com',
+ 'scope' => 'email',
+ 'authorizationUri' => 'https://accounts.google.com/o/oauth2/auth',
+ 'tokenCredentialUri' => 'https://www.googleapis.com/oauth2/v4/token',
+ ]);
+
+ if (isset($config['type']) && $config['type'] == 'service_account') {
+ // return the "jwt" info from the request
+ $method = 'GET';
+ $path = '/auth/info/googlejwt';
+
+ $oauth->setSub('123456');
+ $oauth->setSigningKey($config['private_key']);
+ $oauth->setSigningAlgorithm('RS256');
+ $oauth->setClientId($config['client_id']);
+ $jwt = $oauth->toJwt();
+
+ $headers['Authorization'] = sprintf('Bearer %s', $jwt);
+ } else {
+ // return the "idtoken" info from the request
+ $method = 'GET';
+ $path = '/auth/info/googleidtoken';
+
+ // open the URL
+ $oauth->setClientId($config['installed']['client_id']);
+ $oauth->setClientSecret($config['installed']['client_secret']);
+ $oauth->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
+ $authUrl = $oauth->buildFullAuthorizationUri(['access_type' => 'offline']);
+ `open '$authUrl'`;
+
+ // prompt for the auth code
+ $authCode = readline('Enter the authCode: ');
+ $oauth->setCode($authCode);
+
+ $token = $oauth->fetchAuthToken();
+ if (empty($token['id_token'])) {
+ print('unable to retrieve ID token');
+ return;
+ }
+ $headers['Authorization'] = sprintf('Bearer %s', $token['id_token']);
+ }
+ } else {
+ // return just the message we sent in
+ $method = 'POST';
+ $path = '/echo';
+ $body = json_encode([ 'message' => $message ]);
+ $headers['Content-Type'] = 'application/json';
+ }
+
+ print(sprintf('requesting "%s"...', $path));
+
+ $response = $http->request($method, $path, [
+ 'query' => ['key' => $apiKey],
+ 'body' => $body,
+ 'headers' => $headers
+ ]);
+
+ print((string) $response->getBody());
+}
+
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/endpoints/getting-started/test/EndpointsCommandTest.php b/endpoints/getting-started/test/endpointsTest.php
similarity index 58%
rename from endpoints/getting-started/test/EndpointsCommandTest.php
rename to endpoints/getting-started/test/endpointsTest.php
index 752ef9cfb2..6b15903acf 100644
--- a/endpoints/getting-started/test/EndpointsCommandTest.php
+++ b/endpoints/getting-started/test/endpointsTest.php
@@ -14,13 +14,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+namespace Google\Cloud\Samples\Endpoints;
-use Google\Cloud\Samples\Appengine\Endpoints\EndpointsCommand;
use Google\Cloud\TestUtils\TestTrait;
-use Symfony\Component\Console\Tester\CommandTester;
use PHPUnit\Framework\TestCase;
-class EndpointsCommandTest extends TestCase
+class endpointsTest extends TestCase
{
use TestTrait;
@@ -36,67 +35,46 @@ public function setUp(): void
$this->apiKey = $api_key;
}
- public function testEndpointsCommandWithNoCredentials()
+ public function testEndpointWithNoCredentials()
{
- $command = new EndpointsCommand();
- $tester = new CommandTester($command);
$message = <<runFunctionSnippet('make_request', [
'host' => $this->host,
'api_key' => $this->apiKey,
- '--message' => $message,
- ];
-
- $result = $tester->execute($input);
-
- $this->assertEquals(0, $result);
+ 'credentials' => '',
+ 'message' => $message,
+ ]);
$jsonFlags = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT;
- $this->assertStringContainsString(json_encode($message, $jsonFlags), $tester->getDisplay());
+ $this->assertStringContainsString(json_encode($message, $jsonFlags), $output);
}
public function testEndpointsCommandWithApplicationCredentials()
{
$creds = $this->requireEnv('GOOGLE_APPLICATION_CREDENTIALS');
- $command = new EndpointsCommand();
- $tester = new CommandTester($command);
- $arguments = [
+
+ $output = $this->runFunctionSnippet('make_request', [
'host' => $this->host,
'api_key' => $this->apiKey,
'credentials' => $creds,
- ];
- $options = [];
-
- $result = $tester->execute($arguments, $options);
-
- $this->assertEquals(0, $result);
-
- $credentials = json_decode(file_get_contents($creds), true);
- $this->assertStringContainsString('123456', $tester->getDisplay());
+ ]);
+ $this->assertStringContainsString('123456', $output);
}
public function testEndpointsCommandWithClientSecrets()
{
$creds = $this->requireEnv('GOOGLE_CLIENT_SECRETS');
- $command = new EndpointsCommand();
- $tester = new CommandTester($command);
- $arguments = [
+ $output = $this->runFunctionSnippet('make_request', [
'host' => $this->host,
'api_key' => $this->apiKey,
'credentials' => $creds
- ];
- $options = [];
-
- $result = $tester->execute($arguments, $options);
-
- $this->assertEquals(0, $result);
+ ]);
- $credentials = json_decode(file_get_contents($creds), true);
- $this->assertStringContainsString('id', $tester->getDisplay());
- $this->assertStringContainsString('email', $tester->getDisplay());
+ $this->assertStringContainsString('id', $output);
+ $this->assertStringContainsString('email', $output);
}
}
From 99bdd75c703ad441c6c1bf3094f0fe14b72c1c24 Mon Sep 17 00:00:00 2001
From: Sita Lakshmi Sangameswaran
Date: Thu, 6 Jul 2023 03:10:09 +0530
Subject: [PATCH 042/285] docs(securitycenter): update comments to add new
parent resource types (#1864)
---
securitycenter/src/create_notification.php | 8 ++++++--
securitycenter/src/delete_notification.php | 1 +
securitycenter/src/get_notification.php | 1 +
securitycenter/src/list_notification.php | 8 ++++++--
securitycenter/src/update_notification.php | 1 +
5 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/securitycenter/src/create_notification.php b/securitycenter/src/create_notification.php
index 802db7c82f..3ab8e8a286 100644
--- a/securitycenter/src/create_notification.php
+++ b/securitycenter/src/create_notification.php
@@ -35,7 +35,11 @@ function create_notification(
string $topicName
): void {
$securityCenterClient = new SecurityCenterClient();
- $organizationName = $securityCenterClient::organizationName($organizationId);
+ // 'parent' must be in one of the following formats:
+ // "organizations/{orgId}"
+ // "projects/{projectId}"
+ // "folders/{folderId}"
+ $parent = $securityCenterClient::organizationName($organizationId);
$pubsubTopic = $securityCenterClient::topicName($projectId, $topicName);
$streamingConfig = (new StreamingConfig())->setFilter('state = "ACTIVE"');
@@ -45,7 +49,7 @@ function create_notification(
->setStreamingConfig($streamingConfig);
$response = $securityCenterClient->createNotificationConfig(
- $organizationName,
+ $parent,
$notificationConfigId,
$notificationConfig
);
diff --git a/securitycenter/src/delete_notification.php b/securitycenter/src/delete_notification.php
index 9329e65003..1cc7ac652f 100644
--- a/securitycenter/src/delete_notification.php
+++ b/securitycenter/src/delete_notification.php
@@ -28,6 +28,7 @@ function delete_notification(string $organizationId, string $notificationConfigI
{
$securityCenterClient = new SecurityCenterClient();
$notificationConfigName = $securityCenterClient::notificationConfigName(
+ // You can also use 'projectId' or 'folderId' instead of the 'organizationId'.
$organizationId,
$notificationConfigId
);
diff --git a/securitycenter/src/get_notification.php b/securitycenter/src/get_notification.php
index 936397c1c6..0ee1360ed4 100644
--- a/securitycenter/src/get_notification.php
+++ b/securitycenter/src/get_notification.php
@@ -28,6 +28,7 @@ function get_notification(string $organizationId, string $notificationConfigId):
{
$securityCenterClient = new SecurityCenterClient();
$notificationConfigName = $securityCenterClient::notificationConfigName(
+ // You can also use 'projectId' or 'folderId' instead of the 'organizationId'.
$organizationId,
$notificationConfigId
);
diff --git a/securitycenter/src/list_notification.php b/securitycenter/src/list_notification.php
index 9a0ec61f94..fdc39ecd8b 100644
--- a/securitycenter/src/list_notification.php
+++ b/securitycenter/src/list_notification.php
@@ -26,9 +26,13 @@
function list_notification(string $organizationId): void
{
$securityCenterClient = new SecurityCenterClient();
- $organizationName = $securityCenterClient::organizationName($organizationId);
+ // 'parent' must be in one of the following formats:
+ // "organizations/{orgId}"
+ // "projects/{projectId}"
+ // "folders/{folderId}"
+ $parent = $securityCenterClient::organizationName($organizationId);
- foreach ($securityCenterClient->listNotificationConfigs($organizationName) as $element) {
+ foreach ($securityCenterClient->listNotificationConfigs($parent) as $element) {
printf('Found notification config %s' . PHP_EOL, $element->getName());
}
diff --git a/securitycenter/src/update_notification.php b/securitycenter/src/update_notification.php
index 425b53d379..30042c5002 100644
--- a/securitycenter/src/update_notification.php
+++ b/securitycenter/src/update_notification.php
@@ -40,6 +40,7 @@ function update_notification(
// Ensure this ServiceAccount has the 'pubsub.topics.setIamPolicy' permission on the topic.
// https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/setIamPolicy
$pubsubTopic = $securityCenterClient::topicName($projectId, $topicName);
+ // You can also use 'projectId' or 'folderId' instead of the 'organizationId'.
$notificationConfigName = $securityCenterClient::notificationConfigName($organizationId, $notificationConfigId);
$streamingConfig = (new StreamingConfig())->setFilter('state = "ACTIVE"');
From 12c4dfc0ebd84d535f7b15f3089677de4a3fc377 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 12 Jul 2023 17:22:03 +0530
Subject: [PATCH 043/285] feat(dlp): sample for dlp De-identify (#1858)
---
dlp/src/deidentify_dictionary_replacement.php | 107 ++++++++++
.../deidentify_table_primitive_bucketing.php | 157 +++++++++++++++
dlp/src/deidentify_table_with_crypto_hash.php | 151 +++++++++++++++
...entify_table_with_multiple_crypto_hash.php | 183 ++++++++++++++++++
dlp/src/deidentify_time_extract.php | 142 ++++++++++++++
dlp/test/data/table3.csv | 3 +
dlp/test/data/table4.csv | 6 +
dlp/test/data/table5.csv | 4 +
dlp/test/data/table6.csv | 3 +
dlp/test/dlpTest.php | 118 +++++++++++
10 files changed, 874 insertions(+)
create mode 100644 dlp/src/deidentify_dictionary_replacement.php
create mode 100644 dlp/src/deidentify_table_primitive_bucketing.php
create mode 100644 dlp/src/deidentify_table_with_crypto_hash.php
create mode 100644 dlp/src/deidentify_table_with_multiple_crypto_hash.php
create mode 100644 dlp/src/deidentify_time_extract.php
create mode 100644 dlp/test/data/table3.csv
create mode 100644 dlp/test/data/table4.csv
create mode 100644 dlp/test/data/table5.csv
create mode 100644 dlp/test/data/table6.csv
diff --git a/dlp/src/deidentify_dictionary_replacement.php b/dlp/src/deidentify_dictionary_replacement.php
new file mode 100644
index 0000000000..a8161f9956
--- /dev/null
+++ b/dlp/src/deidentify_dictionary_replacement.php
@@ -0,0 +1,107 @@
+setValue($textToDeIdentify);
+
+ // Specify the type of info the inspection will look for.
+ // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
+ $emailAddress = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([$emailAddress]);
+
+ // Define type of de-identification as replacement with items from dictionary.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceDictionaryConfig(
+ // Specify the dictionary to use for selecting replacement values for the finding.
+ (new ReplaceDictionaryConfig())
+ ->setWordList(
+ // Specify list of value which will randomly replace identified email addresses.
+ (new WordList())
+ ->setWords(['izumi@example.com', 'alex@example.com', 'tal@example.com'])
+ )
+ );
+
+ $transformation = (new InfoTypeTransformation())
+ ->setInfoTypes([$emailAddress])
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ // Construct the configuration for the de-identification request and list all desired transformations.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations(
+ (new InfoTypeTransformations())
+ ->setTransformations([$transformation])
+ );
+
+ // Send the request and receive response from the service.
+ $parent = "projects/$callingProjectId/locations/global";
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print the results.
+ printf('Text after replace with infotype config: %s', $response->getItem()->getValue());
+}
+# [END dlp_deidentify_dictionary_replacement]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_primitive_bucketing.php b/dlp/src/deidentify_table_primitive_bucketing.php
new file mode 100644
index 0000000000..22f64692b3
--- /dev/null
+++ b/dlp/src/deidentify_table_primitive_bucketing.php
@@ -0,0 +1,157 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $contentItem = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify how the content should be de-identified.
+ $buckets = [
+ (new Bucket())
+ ->setMin((new Value())
+ ->setIntegerValue(0))
+ ->setMax((new Value())
+ ->setIntegerValue(25))
+ ->setReplacementValue((new Value())
+ ->setStringValue('LOW')),
+ (new Bucket())
+ ->setMin((new Value())
+ ->setIntegerValue(25))
+ ->setMax((new Value())
+ ->setIntegerValue(75))
+ ->setReplacementValue((new Value())
+ ->setStringValue('Medium')),
+ (new Bucket())
+ ->setMin((new Value())
+ ->setIntegerValue(75))
+ ->setMax((new Value())
+ ->setIntegerValue(100))
+ ->setReplacementValue((new Value())
+ ->setStringValue('High')),
+ ];
+
+ $bucketingConfig = (new BucketingConfig())
+ ->setBuckets($buckets);
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setBucketingConfig($bucketingConfig);
+
+ // Specify the field of the table to be de-identified.
+ $fieldId = (new FieldId())
+ ->setName('score');
+
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields([$fieldId]);
+
+ $recordTransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ // Create the deidentification configuration object.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordTransformations);
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Send the request and receive response from the service.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after deidentify (File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_primitive_bucketing]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_with_crypto_hash.php b/dlp/src/deidentify_table_with_crypto_hash.php
new file mode 100644
index 0000000000..70faa39d04
--- /dev/null
+++ b/dlp/src/deidentify_table_with_crypto_hash.php
@@ -0,0 +1,151 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the type of info the inspection will look for.
+ // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
+ $infoTypes = [
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('PHONE_NUMBER')
+ ];
+
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes);
+
+ // Specify the transient key which will encrypt the data.
+ $cryptoKey = (new CryptoKey())
+ ->setTransient((new TransientCryptoKey())
+ ->setName($transientCryptoKeyName));
+
+ // Specify how the info from the inspection should be encrypted.
+ $cryptoHashConfig = (new CryptoHashConfig())
+ ->setCryptoKey($cryptoKey);
+
+ // Define type of de-identification as cryptographic hash transformation.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setCryptoHashConfig($cryptoHashConfig);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setInfoTypes($infoTypes);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Specify the config for the de-identify request
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Send the request and receive response from the service.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after deidentify (File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_with_crypto_hash]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_table_with_multiple_crypto_hash.php b/dlp/src/deidentify_table_with_multiple_crypto_hash.php
new file mode 100644
index 0000000000..f12bdf94d3
--- /dev/null
+++ b/dlp/src/deidentify_table_with_multiple_crypto_hash.php
@@ -0,0 +1,183 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $content = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the type of info the inspection will look for.
+ // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
+ $infoTypes = [
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('PHONE_NUMBER')
+ ];
+
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes);
+
+ // ---- First Crypto Hash Rule ----
+
+ // Specify the transient key which will encrypt the data.
+ $cryptoHashConfig1 = (new CryptoHashConfig())
+ ->setCryptoKey((new CryptoKey())
+ ->setTransient((new TransientCryptoKey())
+ ->setName($transientCryptoKeyName1)));
+
+ // Define type of de-identification as cryptographic hash transformation.
+ $primitiveTransformation1 = (new PrimitiveTransformation())
+ ->setCryptoHashConfig($cryptoHashConfig1);
+
+ $fieldTransformation1 = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation1)
+ // Specify fields to be de-identified.
+ ->setFields([
+ (new FieldId())->setName('userid')
+ ]);
+
+ // ---- Second Crypto Hash Rule ----
+
+ // Specify the transient key which will encrypt the data.
+ $cryptoHashConfig2 = (new CryptoHashConfig())
+ ->setCryptoKey((new CryptoKey())
+ ->setTransient((new TransientCryptoKey())
+ ->setName($transientCryptoKeyName2)));
+
+ // Define type of de-identification as cryptographic hash transformation.
+ $primitiveTransformation2 = (new PrimitiveTransformation())
+ ->setCryptoHashConfig($cryptoHashConfig2);
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation2)
+ ->setInfoTypes($infoTypes);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ $fieldTransformation2 = (new FieldTransformation())
+ ->setInfoTypeTransformations($infoTypeTransformations)
+ // Specify fields to be de-identified.
+ ->setFields([
+ (new FieldId())->setName('comments')
+ ]);
+
+ $recordtransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation1, $fieldTransformation2]);
+
+ // Specify the config for the de-identify request
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordtransformations);
+
+ // Send the request and receive response from the service.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after deidentify (File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_table_with_multiple_crypto_hash]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/deidentify_time_extract.php b/dlp/src/deidentify_time_extract.php
new file mode 100644
index 0000000000..26a2861ae5
--- /dev/null
+++ b/dlp/src/deidentify_time_extract.php
@@ -0,0 +1,142 @@
+setName($csvHeader);
+ }, $csvHeaders);
+
+ $tableRows = array_map(function ($csvRow) {
+ $rowValues = array_map(function ($csvValue) {
+ return (new Value())
+ ->setStringValue($csvValue);
+ }, explode(',', $csvRow));
+ return (new Row())
+ ->setValues($rowValues);
+ }, $csvRows);
+
+ // Construct the table object.
+ $tableToDeIdentify = (new Table())
+ ->setHeaders($tableHeaders)
+ ->setRows($tableRows);
+
+ // Specify what content you want the service to de-identify.
+ $contentItem = (new ContentItem())
+ ->setTable($tableToDeIdentify);
+
+ // Specify the time part to extract.
+ $timePartConfig = (new TimePartConfig())
+ ->setPartToExtract(TimePart::YEAR);
+
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setTimePartConfig($timePartConfig);
+
+ // Specify which fields the TimePart should apply too.
+ $fieldIds = [
+ (new FieldId())
+ ->setName('Birth_Date'),
+ (new FieldId())
+ ->setName('Register_Date')
+ ];
+
+ $fieldTransformation = (new FieldTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation)
+ ->setFields($fieldIds);
+
+ $recordTransformations = (new RecordTransformations())
+ ->setFieldTransformations([$fieldTransformation]);
+
+ // Construct the configuration for the de-id request and list all desired transformations.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setRecordTransformations($recordTransformations);
+
+ $parent = "projects/$callingProjectId/locations/global";
+
+ // Send the request and receive response from the service.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $contentItem
+ ]);
+
+ // Print the results.
+ $csvRef = fopen($outputCsvFile, 'w');
+ fputcsv($csvRef, $csvHeaders);
+ foreach ($response->getItem()->getTable()->getRows() as $tableRow) {
+ $values = array_map(function ($tableValue) {
+ return $tableValue->getStringValue();
+ }, iterator_to_array($tableRow->getValues()));
+ fputcsv($csvRef, $values);
+ };
+ printf('Table after deidentify (File Location): %s', $outputCsvFile);
+}
+# [END dlp_deidentify_time_extract]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/data/table3.csv b/dlp/test/data/table3.csv
new file mode 100644
index 0000000000..4bbc0c63c0
--- /dev/null
+++ b/dlp/test/data/table3.csv
@@ -0,0 +1,3 @@
+Name,Birth_Date,Credit_Card,Register_Date
+Alex,01/01/1970,4532908762519852,07/21/1996
+Charlie,03/06/1988,4301261899725540,04/09/2001
\ No newline at end of file
diff --git a/dlp/test/data/table4.csv b/dlp/test/data/table4.csv
new file mode 100644
index 0000000000..5c6d1c7843
--- /dev/null
+++ b/dlp/test/data/table4.csv
@@ -0,0 +1,6 @@
+user_id,score
+1,99
+2,98
+3,92
+4,24
+5,55
diff --git a/dlp/test/data/table5.csv b/dlp/test/data/table5.csv
new file mode 100644
index 0000000000..81a27ae80d
--- /dev/null
+++ b/dlp/test/data/table5.csv
@@ -0,0 +1,4 @@
+userid,comments
+user1@example.org,my email is user1@example.org and phone is 858-555-0222
+user2@example.org,my email is user2@example.org and phone is 858-555-0223
+user3@example.org,my email is user3@example.org and phone is 858-555-0224
\ No newline at end of file
diff --git a/dlp/test/data/table6.csv b/dlp/test/data/table6.csv
new file mode 100644
index 0000000000..c5031ba683
--- /dev/null
+++ b/dlp/test/data/table6.csv
@@ -0,0 +1,3 @@
+userid,comments
+user1@example.org,my email is user1@example.org and phone is 858-333-2222
+abbyabernathy1,my userid is abbyabernathy1 and my email is aabernathy@example.com
\ No newline at end of file
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index f29c32d7d6..f897026965 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
namespace Google\Cloud\Samples\Dlp;
use Google\Cloud\TestUtils\TestTrait;
@@ -877,4 +878,121 @@ public function testRedactImageColoredInfotypes()
);
unlink($outputPath);
}
+
+ public function testDeidentifyTimeExtract()
+ {
+ $inputCsvFile = __DIR__ . '/data/table3.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_time_extract_output_unittest.csv';
+
+ $output = $this->runFunctionSnippet('deidentify_time_extract', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString(',1970', $csvLines_ouput[1]);
+
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyDictionaryReplacement()
+ {
+ $string = 'My name is Charlie and email address is charlie@example.com.';
+ $output = $this->runFunctionSnippet('deidentify_dictionary_replacement', [
+ self::$projectId,
+ $string
+ ]);
+ $this->assertStringNotContainsString('charlie@example.com', $output);
+ $this->assertNotEquals($output, $string);
+ }
+
+ public function testDeidentifyTablePrimitiveBucketing()
+ {
+ $inputCsvFile = __DIR__ . '/data/table4.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_primitive_bucketing_output_unittest.csv';
+
+ $output = $this->runFunctionSnippet('deidentify_table_primitive_bucketing', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringContainsString('High', $csvLines_ouput[1]);
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableWithCryptoHash()
+ {
+ $inputCsvFile = __DIR__ . '/data/table5.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_with_crypto_hash_output_unittest.csv';
+ // Generate randome string.
+ $transientCryptoKeyName = sha1(rand());
+
+ $output = $this->runFunctionSnippet('deidentify_table_with_crypto_hash', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile,
+ $transientCryptoKeyName
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringNotContainsString('user1@example.org', $csvLines_ouput[1]);
+ unlink($outputCsvFile);
+ }
+
+ public function testDeidentifyTableWithMultipleCryptoHash()
+ {
+ $inputCsvFile = __DIR__ . '/data/table6.csv';
+ $outputCsvFile = __DIR__ . '/data/deidentify_table_with_multiple_crypto_hash_output_unittest.csv';
+ // Generate randome string.
+ $transientCryptoKeyName1 = sha1(rand());
+ $transientCryptoKeyName2 = sha1(rand());
+
+ $output = $this->runFunctionSnippet('deidentify_table_with_multiple_crypto_hash', [
+ self::$projectId,
+ $inputCsvFile,
+ $outputCsvFile,
+ $transientCryptoKeyName1,
+ $transientCryptoKeyName2
+ ]);
+
+ $this->assertNotEquals(
+ sha1_file($outputCsvFile),
+ sha1_file($inputCsvFile)
+ );
+
+ $csvLines_input = file($inputCsvFile, FILE_IGNORE_NEW_LINES);
+ $csvLines_ouput = file($outputCsvFile, FILE_IGNORE_NEW_LINES);
+
+ $this->assertEquals($csvLines_input[0], $csvLines_ouput[0]);
+ $this->assertStringNotContainsString('user1@example.org', $csvLines_ouput[1]);
+ $this->assertStringContainsString('abbyabernathy1', $csvLines_ouput[2]);
+ unlink($outputCsvFile);
+ }
}
From ec929afe8917616102095d34eb8336bed7085588 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 12 Jul 2023 19:18:17 +0530
Subject: [PATCH 044/285] feat(dlp): DLP de-identify cloud storage (#1856)
---
dlp/src/deidentify_cloud_storage.php | 181 +++++++++++++++++++++++++++
dlp/test/dlpTest.php | 87 +++++++++++++
2 files changed, 268 insertions(+)
create mode 100644 dlp/src/deidentify_cloud_storage.php
diff --git a/dlp/src/deidentify_cloud_storage.php b/dlp/src/deidentify_cloud_storage.php
new file mode 100644
index 0000000000..76dfc72878
--- /dev/null
+++ b/dlp/src/deidentify_cloud_storage.php
@@ -0,0 +1,181 @@
+setFileSet((new FileSet())
+ ->setUrl($inputgcsPath));
+ $storageConfig = (new StorageConfig())
+ ->setCloudStorageOptions(($cloudStorageOptions));
+
+ // Specify the type of info the inspection will look for.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([
+ (new InfoType())->setName('PERSON_NAME'),
+ (new InfoType())->setName('EMAIL_ADDRESS')
+ ]);
+
+ // Specify the big query table to store the transformation details.
+ $transformationDetailsStorageConfig = (new TransformationDetailsStorageConfig())
+ ->setTable((new BigQueryTable())
+ ->setProjectId($callingProjectId)
+ ->setDatasetId($datasetId)
+ ->setTableId($tableId));
+
+ // Specify the de-identify template used for the transformation.
+ $transformationConfig = (new TransformationConfig())
+ ->setDeidentifyTemplate(
+ DlpServiceBaseClient::projectDeidentifyTemplateName($callingProjectId, $deidentifyTemplateName)
+ )
+ ->setStructuredDeidentifyTemplate(
+ DlpServiceBaseClient::projectDeidentifyTemplateName($callingProjectId, $structuredDeidentifyTemplateName)
+ )
+ ->setImageRedactTemplate(
+ DlpServiceBaseClient::projectDeidentifyTemplateName($callingProjectId, $imageRedactTemplateName)
+ );
+
+ $deidentify = (new Deidentify())
+ ->setCloudStorageOutput($outgcsPath)
+ ->setTransformationConfig($transformationConfig)
+ ->setTransformationDetailsStorageConfig($transformationDetailsStorageConfig)
+ ->setFileTypesToTransform([FileType::TEXT_FILE, FileType::IMAGE, FileType::CSV]);
+
+ $action = (new Action())
+ ->setDeidentify($deidentify);
+
+ // Configure the inspection job we want the service to perform.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Send the job creation request and process the response.
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJobConfig
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(30);
+ $job = $dlp->getDlpJob($job->getName());
+ if ($job->getState() == JobState::DONE) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_deidentify_cloud_storage]
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index f897026965..36e0bca185 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -18,9 +18,18 @@
namespace Google\Cloud\Samples\Dlp;
+use Google\Cloud\Dlp\V2\DlpJob;
+use Google\Cloud\Dlp\V2\DlpJob\JobState;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
use PHPUnitRetry\RetryTrait;
+use Google\Cloud\Dlp\V2\DlpServiceClient;
+use Google\Cloud\Dlp\V2\InfoType;
+use Google\Cloud\Dlp\V2\InfoTypeStats;
+use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
+use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
/**
* Unit Tests for dlp commands.
@@ -29,6 +38,7 @@ class dlpTest extends TestCase
{
use TestTrait;
use RetryTrait;
+ use ProphecyTrait;
public function testInspectImageFile()
{
@@ -995,4 +1005,81 @@ public function testDeidentifyTableWithMultipleCryptoHash()
$this->assertStringContainsString('abbyabernathy1', $csvLines_ouput[2]);
unlink($outputCsvFile);
}
+
+ public function testDeidentifyCloudStorage()
+ {
+ $bucketName = $this->requireEnv('GOOGLE_STORAGE_BUCKET');
+ $inputgcsPath = 'gs://' . $bucketName;
+ $outgcsPath = 'gs://' . $bucketName;
+ $deidentifyTemplateName = $this->requireEnv('DLP_DEIDENTIFY_TEMPLATE');
+ $structuredDeidentifyTemplateName = $this->requireEnv('DLP_STRUCTURED_DEIDENTIFY_TEMPLATE');
+ $imageRedactTemplateName = $this->requireEnv('DLP_IMAGE_REDACT_DEIDENTIFY_TEMPLATE');
+ $datasetId = $this->requireEnv('DLP_DATASET_ID');
+ $tableId = $this->requireEnv('DLP_TABLE_ID');
+
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/1234')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/1234')
+ ->setState(JobState::DONE)
+ ->setInspectDetails((new InspectDataSourceDetails())
+ ->setResult((new Result())
+ ->setInfoTypeStats([
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('PERSON_NAME'))
+ ->setCount(6),
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('EMAIL_ADDRESS'))
+ ->setCount(9)
+ ])));
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ // Creating a temp file for testing.
+ $sampleFile = __DIR__ . '/../src/deidentify_cloud_storage.php';
+ $tmpFileName = basename($sampleFile, '.php') . '_temp';
+ $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements = [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ 'deidentify_cloud_storage' => $tmpFileName
+ ];
+ $fileContent = strtr($fileContent, $replacements);
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent
+ );
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ $output = $this->runFunctionSnippet($tmpFileName, [
+ self::$projectId,
+ $inputgcsPath,
+ $outgcsPath,
+ $deidentifyTemplateName,
+ $structuredDeidentifyTemplateName,
+ $imageRedactTemplateName,
+ $datasetId,
+ $tableId
+ ]);
+
+ // delete a temp file.
+ unlink($tmpFilePath);
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ $this->assertStringContainsString('infoType EMAIL_ADDRESS', $output);
+ }
}
From 02c1303c86695a695ade78c3c37780f33e0dc966 Mon Sep 17 00:00:00 2001
From: Nicholas Cook
Date: Wed, 19 Jul 2023 12:31:08 -0700
Subject: [PATCH 045/285] feat(VideoStitcher): update slates and CDN keys to
return LROs; add live config samples and tests (#1876)
---
media/videostitcher/composer.json | 2 +-
media/videostitcher/src/create_cdn_key.php | 14 ++-
.../src/create_cdn_key_akamai.php | 14 ++-
.../videostitcher/src/create_live_config.php | 84 ++++++++++++++
.../videostitcher/src/create_live_session.php | 23 +---
media/videostitcher/src/create_slate.php | 14 ++-
.../videostitcher/src/create_vod_session.php | 2 +
media/videostitcher/src/delete_cdn_key.php | 13 ++-
.../videostitcher/src/delete_live_config.php | 60 ++++++++++
media/videostitcher/src/delete_slate.php | 13 ++-
media/videostitcher/src/get_live_config.php | 55 +++++++++
media/videostitcher/src/list_live_configs.php | 57 ++++++++++
media/videostitcher/src/update_cdn_key.php | 14 ++-
.../src/update_cdn_key_akamai.php | 14 ++-
media/videostitcher/src/update_slate.php | 14 ++-
.../videostitcher/test/videoStitcherTest.php | 107 +++++++++++++++++-
16 files changed, 446 insertions(+), 54 deletions(-)
create mode 100644 media/videostitcher/src/create_live_config.php
create mode 100644 media/videostitcher/src/delete_live_config.php
create mode 100644 media/videostitcher/src/get_live_config.php
create mode 100644 media/videostitcher/src/list_live_configs.php
diff --git a/media/videostitcher/composer.json b/media/videostitcher/composer.json
index 15a32e7306..24eb0adbd6 100644
--- a/media/videostitcher/composer.json
+++ b/media/videostitcher/composer.json
@@ -2,6 +2,6 @@
"name": "google/video-stitcher-sample",
"type": "project",
"require": {
- "google/cloud-video-stitcher": "^0.3.0"
+ "google/cloud-video-stitcher": "^0.7.0"
}
}
diff --git a/media/videostitcher/src/create_cdn_key.php b/media/videostitcher/src/create_cdn_key.php
index 820dfc3a58..05b4361d7b 100644
--- a/media/videostitcher/src/create_cdn_key.php
+++ b/media/videostitcher/src/create_cdn_key.php
@@ -75,10 +75,16 @@ function create_cdn_key(
$cloudCdn->setPrivateKey($privateKey);
// Run CDN key creation request
- $response = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
-
- // Print results
- printf('CDN key: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('CDN key: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_create_cdn_key]
diff --git a/media/videostitcher/src/create_cdn_key_akamai.php b/media/videostitcher/src/create_cdn_key_akamai.php
index a3f7b0faf6..146ace93e3 100644
--- a/media/videostitcher/src/create_cdn_key_akamai.php
+++ b/media/videostitcher/src/create_cdn_key_akamai.php
@@ -57,10 +57,16 @@ function create_cdn_key_akamai(
$cdnKey->setAkamaiCdnKey($cloudCdn);
// Run CDN key creation request
- $response = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
-
- // Print results
- printf('CDN key: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('CDN key: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_create_cdn_key_akamai]
diff --git a/media/videostitcher/src/create_live_config.php b/media/videostitcher/src/create_live_config.php
new file mode 100644
index 0000000000..807cdcca52
--- /dev/null
+++ b/media/videostitcher/src/create_live_config.php
@@ -0,0 +1,84 @@
+locationName($callingProjectId, $location);
+ $defaultSlate = $stitcherClient->slateName($callingProjectId, $location, $slateId);
+
+ $liveConfig = (new LiveConfig())
+ ->setSourceUri($sourceUri)
+ ->setAdTagUri($adTagUri)
+ ->setAdTracking(AdTracking::SERVER)
+ ->setStitchingPolicy(LiveConfig\StitchingPolicy::CUT_CURRENT)
+ ->setDefaultSlate($defaultSlate);
+
+ // Run live config creation request
+ $operationResponse = $stitcherClient->createLiveConfig($parent, $liveConfigId, $liveConfig);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Live config: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
+}
+// [END videostitcher_create_live_config]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/videostitcher/src/create_live_session.php b/media/videostitcher/src/create_live_session.php
index af8b03e561..06ef787457 100644
--- a/media/videostitcher/src/create_live_session.php
+++ b/media/videostitcher/src/create_live_session.php
@@ -25,7 +25,6 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_live_session]
-use Google\Cloud\Video\Stitcher\V1\AdTag;
use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\LiveSession;
@@ -35,33 +34,21 @@
*
* @param string $callingProjectId The project ID to run the API call under
* @param string $location The location of the session
- * @param string $sourceUri Uri of the media to stitch; this URI must
- * reference either an MPEG-DASH manifest
- * (.mpd) file or an M3U playlist manifest
- * (.m3u8) file.
- * @param string $adTagUri The Uri of the ad tag
- * @param string $slateId The user-defined slate ID of the default
- * slate to use when no slates are specified
- * in an ad break's message
+ * @param string $liveConfigId The live config ID to use to create the
+ * live session
*/
function create_live_session(
string $callingProjectId,
string $location,
- string $sourceUri,
- string $adTagUri,
- string $slateId
+ string $liveConfigId
): void {
// Instantiate a client.
$stitcherClient = new VideoStitcherServiceClient();
$parent = $stitcherClient->locationName($callingProjectId, $location);
+ $liveConfig = $stitcherClient->liveConfigName($callingProjectId, $location, $liveConfigId);
$liveSession = new LiveSession();
- $liveSession->setSourceUri($sourceUri);
- $liveSession->setAdTagMap([
- 'default' => (new AdTag())
- ->setUri($adTagUri)
- ]);
- $liveSession->setDefaultSlateId($slateId);
+ $liveSession->setLiveConfig($liveConfig);
// Run live session creation request
$response = $stitcherClient->createLiveSession($parent, $liveSession);
diff --git a/media/videostitcher/src/create_slate.php b/media/videostitcher/src/create_slate.php
index aa54715bd7..00dcb4f718 100644
--- a/media/videostitcher/src/create_slate.php
+++ b/media/videostitcher/src/create_slate.php
@@ -50,10 +50,16 @@ function create_slate(
$slate->setUri($slateUri);
// Run slate creation request
- $response = $stitcherClient->createSlate($parent, $slateId, $slate);
-
- // Print results
- printf('Slate: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->createSlate($parent, $slateId, $slate);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Slate: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_create_slate]
diff --git a/media/videostitcher/src/create_vod_session.php b/media/videostitcher/src/create_vod_session.php
index bcbc3a7fc5..3d6c4cfa9f 100644
--- a/media/videostitcher/src/create_vod_session.php
+++ b/media/videostitcher/src/create_vod_session.php
@@ -26,6 +26,7 @@
// [START videostitcher_create_vod_session]
use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\AdTracking;
use Google\Cloud\Video\Stitcher\V1\VodSession;
/**
@@ -53,6 +54,7 @@ function create_vod_session(
$vodSession = new VodSession();
$vodSession->setSourceUri($sourceUri);
$vodSession->setAdTagUri($adTagUri);
+ $vodSession->setAdTracking(AdTracking::SERVER);
// Run VOD session creation request
$response = $stitcherClient->createVodSession($parent, $vodSession);
diff --git a/media/videostitcher/src/delete_cdn_key.php b/media/videostitcher/src/delete_cdn_key.php
index 48f63180f2..0366265f0a 100644
--- a/media/videostitcher/src/delete_cdn_key.php
+++ b/media/videostitcher/src/delete_cdn_key.php
@@ -43,10 +43,15 @@ function delete_cdn_key(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->cdnKeyName($callingProjectId, $location, $cdnKeyId);
- $stitcherClient->deleteCdnKey($formattedName);
-
- // Print status
- printf('Deleted CDN key %s' . PHP_EOL, $cdnKeyId);
+ $operationResponse = $stitcherClient->deleteCdnKey($formattedName);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ // Print status
+ printf('Deleted CDN key %s' . PHP_EOL, $cdnKeyId);
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_delete_cdn_key]
diff --git a/media/videostitcher/src/delete_live_config.php b/media/videostitcher/src/delete_live_config.php
new file mode 100644
index 0000000000..4ebf8badb5
--- /dev/null
+++ b/media/videostitcher/src/delete_live_config.php
@@ -0,0 +1,60 @@
+liveConfigName($callingProjectId, $location, $liveConfigId);
+ $operationResponse = $stitcherClient->deleteLiveConfig($formattedName);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ // Print status
+ printf('Deleted live config %s' . PHP_EOL, $liveConfigId);
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
+}
+// [END videostitcher_delete_live_config]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/videostitcher/src/delete_slate.php b/media/videostitcher/src/delete_slate.php
index 81eb1c5069..69576bd67f 100644
--- a/media/videostitcher/src/delete_slate.php
+++ b/media/videostitcher/src/delete_slate.php
@@ -43,10 +43,15 @@ function delete_slate(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->slateName($callingProjectId, $location, $slateId);
- $stitcherClient->deleteSlate($formattedName);
-
- // Print status
- printf('Deleted slate %s' . PHP_EOL, $slateId);
+ $operationResponse = $stitcherClient->deleteSlate($formattedName);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ // Print status
+ printf('Deleted slate %s' . PHP_EOL, $slateId);
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_delete_slate]
diff --git a/media/videostitcher/src/get_live_config.php b/media/videostitcher/src/get_live_config.php
new file mode 100644
index 0000000000..ac3a559a75
--- /dev/null
+++ b/media/videostitcher/src/get_live_config.php
@@ -0,0 +1,55 @@
+liveConfigName($callingProjectId, $location, $liveConfigId);
+ $liveConfig = $stitcherClient->getLiveConfig($formattedName);
+
+ // Print results
+ printf('Live config: %s' . PHP_EOL, $liveConfig->getName());
+}
+// [END videostitcher_get_live_config]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/videostitcher/src/list_live_configs.php b/media/videostitcher/src/list_live_configs.php
new file mode 100644
index 0000000000..6062fbcfa4
--- /dev/null
+++ b/media/videostitcher/src/list_live_configs.php
@@ -0,0 +1,57 @@
+locationName($callingProjectId, $location);
+ $response = $stitcherClient->listLiveConfigs($parent);
+
+ // Print the live config list.
+ $liveConfigs = $response->iterateAllElements();
+ print('Live configs:' . PHP_EOL);
+ foreach ($liveConfigs as $liveConfig) {
+ printf('%s' . PHP_EOL, $liveConfig->getName());
+ }
+}
+// [END videostitcher_list_live_configs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/videostitcher/src/update_cdn_key.php b/media/videostitcher/src/update_cdn_key.php
index c0e9154ebb..0678c432ad 100644
--- a/media/videostitcher/src/update_cdn_key.php
+++ b/media/videostitcher/src/update_cdn_key.php
@@ -84,10 +84,16 @@ function update_cdn_key(
$cloudCdn->setPrivateKey($privateKey);
// Run CDN key creation request
- $response = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
-
- // Print results
- printf('Updated CDN key: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Updated CDN key: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_update_cdn_key]
diff --git a/media/videostitcher/src/update_cdn_key_akamai.php b/media/videostitcher/src/update_cdn_key_akamai.php
index 2ab3faa122..ca0d9b7cfb 100644
--- a/media/videostitcher/src/update_cdn_key_akamai.php
+++ b/media/videostitcher/src/update_cdn_key_akamai.php
@@ -63,10 +63,16 @@ function update_cdn_key_akamai(
]);
// Run CDN key creation request
- $response = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
-
- // Print results
- printf('Updated CDN key: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Updated CDN key: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_update_cdn_key_akamai]
diff --git a/media/videostitcher/src/update_slate.php b/media/videostitcher/src/update_slate.php
index 857398421c..68681d6f3e 100644
--- a/media/videostitcher/src/update_slate.php
+++ b/media/videostitcher/src/update_slate.php
@@ -55,10 +55,16 @@ function update_slate(
]);
// Run slate update request
- $response = $stitcherClient->updateSlate($slate, $updateMask);
-
- // Print results
- printf('Updated slate: %s' . PHP_EOL, $response->getName());
+ $operationResponse = $stitcherClient->updateSlate($slate, $updateMask);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Updated slate: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
}
// [END videostitcher_update_slate]
diff --git a/media/videostitcher/test/videoStitcherTest.php b/media/videostitcher/test/videoStitcherTest.php
index 7d6529309e..84843564ec 100644
--- a/media/videostitcher/test/videoStitcherTest.php
+++ b/media/videostitcher/test/videoStitcherTest.php
@@ -67,6 +67,9 @@ class videoStitcherTest extends TestCase
private static $akamaiTokenKey = 'VGhpcyBpcyBhIHRlc3Qgc3RyaW5nLg==';
private static $updatedAkamaiTokenKey = 'VGhpcyBpcyBhbiB1cGRhdGVkIHRlc3Qgc3RyaW5nLg==';
+ private static $liveConfigId;
+ private static $liveConfigName;
+
private static $inputBucketName = 'cloud-samples-data';
private static $inputVodFileName = '/media/hls-vod/manifest.m3u8';
private static $vodUri;
@@ -94,6 +97,7 @@ public static function setUpBeforeClass(): void
self::deleteOldSlates();
self::deleteOldCdnKeys();
+ self::deleteOldLiveConfigs();
self::$slateUri = sprintf('https://storage.googleapis.com/%s%s', self::$bucket, self::$slateFileName);
self::$updatedSlateUri = sprintf('https://storage.googleapis.com/%s%s', self::$bucket, self::$updatedSlateFileName);
@@ -357,6 +361,65 @@ public function testDeleteAkamaiCdnKey()
$this->assertStringContainsString('Deleted CDN key', $output);
}
+ public function testCreateLiveConfig()
+ {
+ # Create a temporary slate for the live session (required)
+ $tempSlateId = sprintf('php-test-slate-%s-%s', uniqid(), time());
+ $this->runFunctionSnippet('create_slate', [
+ self::$projectId,
+ self::$location,
+ $tempSlateId,
+ self::$slateUri
+ ]);
+
+ self::$liveConfigId = sprintf('php-test-live-config-%s-%s', uniqid(), time());
+ # API returns project number rather than project ID so
+ # don't include that in $liveConfigName since we don't have it
+ self::$liveConfigName = sprintf('/locations/%s/liveConfigs/%s', self::$location, self::$liveConfigId);
+
+ $output = $this->runFunctionSnippet('create_live_config', [
+ self::$projectId,
+ self::$location,
+ self::$liveConfigId,
+ self::$liveUri,
+ self::$liveAgTagUri,
+ $tempSlateId
+ ]);
+ $this->assertStringContainsString(self::$liveConfigName, $output);
+ }
+
+ /** @depends testCreateLiveConfig */
+ public function testListLiveConfigs()
+ {
+ $output = $this->runFunctionSnippet('list_live_configs', [
+ self::$projectId,
+ self::$location
+ ]);
+ $this->assertStringContainsString(self::$liveConfigName, $output);
+ }
+
+ /** @depends testListLiveConfigs */
+ public function testGetLiveConfig()
+ {
+ $output = $this->runFunctionSnippet('get_live_config', [
+ self::$projectId,
+ self::$location,
+ self::$liveConfigId
+ ]);
+ $this->assertStringContainsString(self::$liveConfigName, $output);
+ }
+
+ /** @depends testGetLiveConfig */
+ public function testDeleteLiveConfig()
+ {
+ $output = $this->runFunctionSnippet('delete_live_config', [
+ self::$projectId,
+ self::$location,
+ self::$liveConfigId
+ ]);
+ $this->assertStringContainsString('Deleted live config', $output);
+ }
+
public function testCreateVodSession()
{
# API returns project number rather than project ID so
@@ -451,6 +514,17 @@ public function testCreateLiveSession()
self::$slateUri
]);
+ # Create a temporary live config for the live session (required)
+ $tempLiveConfigId = sprintf('php-test-live-config-%s-%s', uniqid(), time());
+ $this->runFunctionSnippet('create_live_config', [
+ self::$projectId,
+ self::$location,
+ $tempLiveConfigId,
+ self::$liveUri,
+ self::$liveAgTagUri,
+ $tempSlateId
+ ]);
+
# API returns project number rather than project ID so
# don't include that in $liveSessionName since we don't have it
self::$liveSessionName = sprintf('/locations/%s/liveSessions/', self::$location);
@@ -458,15 +532,20 @@ public function testCreateLiveSession()
$output = $this->runFunctionSnippet('create_live_session', [
self::$projectId,
self::$location,
- self::$liveUri,
- self::$liveAgTagUri,
- $tempSlateId
+ $tempLiveConfigId
]);
$this->assertStringContainsString(self::$liveSessionName, $output);
self::$liveSessionId = explode('/', $output);
self::$liveSessionId = trim(self::$liveSessionId[(count(self::$liveSessionId) - 1)]);
self::$liveSessionName = sprintf('/locations/%s/liveSessions/%s', self::$location, self::$liveSessionId);
+ # Delete the temporary live config
+ $this->runFunctionSnippet('delete_live_config', [
+ self::$projectId,
+ self::$location,
+ $tempLiveConfigId
+ ]);
+
# Delete the temporary slate
$this->runFunctionSnippet('delete_slate', [
self::$projectId,
@@ -581,4 +660,26 @@ private static function deleteOldCdnKeys(): void
}
}
}
+
+ private static function deleteOldLiveConfigs(): void
+ {
+ $stitcherClient = new VideoStitcherServiceClient();
+ $parent = $stitcherClient->locationName(self::$projectId, self::$location);
+ $response = $stitcherClient->listLiveConfigs($parent);
+ $liveConfigs = $response->iterateAllElements();
+
+ $currentTime = time();
+ $oneHourInSecs = 60 * 60 * 1;
+
+ foreach ($liveConfigs as $liveConfig) {
+ $tmp = explode('/', $liveConfig->getName());
+ $id = end($tmp);
+ $tmp = explode('-', $id);
+ $timestamp = intval(end($tmp));
+
+ if ($currentTime - $timestamp >= $oneHourInSecs) {
+ $stitcherClient->deleteLiveConfig($liveConfig->getName());
+ }
+ }
+ }
}
From 9fce5845b0c3d4570f77874ea139f9c3212c5193 Mon Sep 17 00:00:00 2001
From: Vishwaraj Anand
Date: Thu, 20 Jul 2023 15:39:33 +0530
Subject: [PATCH 046/285] chore: phpunit migrate configuration (#1875)
---
bigquery/api/phpunit.xml.dist | 35 ++++++++++----------
bigquery/stackoverflow/phpunit.xml.dist | 37 ++++++++++-----------
bigtable/phpunit.xml.dist | 43 +++++++++++--------------
datastore/api/phpunit.xml.dist | 35 ++++++++++----------
datastore/quickstart/phpunit.xml.dist | 35 ++++++++++----------
datastore/tutorial/phpunit.xml.dist | 35 ++++++++++----------
firestore/phpunit.xml.dist | 41 +++++++++++------------
pubsub/api/phpunit.xml.dist | 41 +++++++++++------------
pubsub/app/phpunit.xml.dist | 37 ++++++++++-----------
pubsub/quickstart/phpunit.xml.dist | 35 ++++++++++----------
spanner/phpunit.xml.dist | 43 +++++++++++++------------
storage/phpunit.xml.dist | 41 +++++++++++------------
12 files changed, 231 insertions(+), 227 deletions(-)
diff --git a/bigquery/api/phpunit.xml.dist b/bigquery/api/phpunit.xml.dist
index b038a4558e..511b2eb818 100644
--- a/bigquery/api/phpunit.xml.dist
+++ b/bigquery/api/phpunit.xml.dist
@@ -14,21 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/bigquery/stackoverflow/phpunit.xml.dist b/bigquery/stackoverflow/phpunit.xml.dist
index e35dbae6fe..62a8e5d092 100644
--- a/bigquery/stackoverflow/phpunit.xml.dist
+++ b/bigquery/stackoverflow/phpunit.xml.dist
@@ -14,22 +14,23 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- shakespeare.php
- ./src
-
- ./vendor
-
-
-
+
+
+
+ shakespeare.php
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/bigtable/phpunit.xml.dist b/bigtable/phpunit.xml.dist
index bbf654bccb..030dbdcbda 100644
--- a/bigtable/phpunit.xml.dist
+++ b/bigtable/phpunit.xml.dist
@@ -14,29 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/datastore/api/phpunit.xml.dist b/datastore/api/phpunit.xml.dist
index a4325d1ae9..f3726c50fe 100644
--- a/datastore/api/phpunit.xml.dist
+++ b/datastore/api/phpunit.xml.dist
@@ -14,21 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/datastore/quickstart/phpunit.xml.dist b/datastore/quickstart/phpunit.xml.dist
index c551d22d87..6968f12464 100644
--- a/datastore/quickstart/phpunit.xml.dist
+++ b/datastore/quickstart/phpunit.xml.dist
@@ -14,21 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- quickstart.php
-
- ./vendor
-
-
-
+
+
+
+ quickstart.php
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/datastore/tutorial/phpunit.xml.dist b/datastore/tutorial/phpunit.xml.dist
index 227b71895c..d4961b5a5b 100644
--- a/datastore/tutorial/phpunit.xml.dist
+++ b/datastore/tutorial/phpunit.xml.dist
@@ -14,21 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/firestore/phpunit.xml.dist b/firestore/phpunit.xml.dist
index 80ac23e923..299d9d20bf 100644
--- a/firestore/phpunit.xml.dist
+++ b/firestore/phpunit.xml.dist
@@ -14,24 +14,25 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
+
+
+
diff --git a/pubsub/api/phpunit.xml.dist b/pubsub/api/phpunit.xml.dist
index 2045d0bbbd..89e11c686f 100644
--- a/pubsub/api/phpunit.xml.dist
+++ b/pubsub/api/phpunit.xml.dist
@@ -14,24 +14,25 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
+
+
+
diff --git a/pubsub/app/phpunit.xml.dist b/pubsub/app/phpunit.xml.dist
index 96c2523e20..5ba6648f39 100644
--- a/pubsub/app/phpunit.xml.dist
+++ b/pubsub/app/phpunit.xml.dist
@@ -14,22 +14,23 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
- test/DeployAppEngineFlexTest.php
-
-
-
-
-
-
-
- app.php
-
- ./vendor
-
-
-
+
+
+
+ app.php
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+ test/DeployAppEngineFlexTest.php
+
+
+
diff --git a/pubsub/quickstart/phpunit.xml.dist b/pubsub/quickstart/phpunit.xml.dist
index 20a678cc29..112cc7e170 100644
--- a/pubsub/quickstart/phpunit.xml.dist
+++ b/pubsub/quickstart/phpunit.xml.dist
@@ -14,21 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- quickstart.php
-
- ./vendor
-
-
-
+
+
+
+ quickstart.php
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
diff --git a/spanner/phpunit.xml.dist b/spanner/phpunit.xml.dist
index a0d97d3121..7e4cf8c348 100644
--- a/spanner/phpunit.xml.dist
+++ b/spanner/phpunit.xml.dist
@@ -14,25 +14,26 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- src
- quickstart.php
-
- ./vendor
-
-
-
-
-
-
+
+
+
+ src
+ quickstart.php
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
+
+
+
diff --git a/storage/phpunit.xml.dist b/storage/phpunit.xml.dist
index 0183151bb7..c074091b30 100644
--- a/storage/phpunit.xml.dist
+++ b/storage/phpunit.xml.dist
@@ -14,24 +14,25 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-
-
- test
-
-
-
-
-
-
-
- ./src
-
- ./vendor
-
-
-
-
-
-
+
+
+
+ ./src
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
+
+
+
From 54ddb5c37aa112aeccad5320a7baa074e29c7c79 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:07:31 -0600
Subject: [PATCH 047/285] chore: upgrade analyticsdata samples to new GAPIC
(#1873)
---
analyticsdata/composer.json | 2 +-
analyticsdata/quickstart.php | 29 +++++++-------
analyticsdata/quickstart_oauth2/index.php | 29 +++++++-------
.../src/client_from_json_credentials.php | 2 +-
analyticsdata/src/get_common_metadata.php | 7 +++-
.../src/get_metadata_by_property_id.php | 7 +++-
analyticsdata/src/run_batch_report.php | 13 ++++---
analyticsdata/src/run_pivot_report.php | 25 ++++++------
analyticsdata/src/run_realtime_report.php | 13 ++++---
...altime_report_with_multiple_dimensions.php | 15 +++----
..._realtime_report_with_multiple_metrics.php | 15 +++----
analyticsdata/src/run_report.php | 21 +++++-----
.../src/run_report_with_aggregations.php | 23 +++++------
analyticsdata/src/run_report_with_cohorts.php | 27 ++++++-------
.../src/run_report_with_date_ranges.php | 17 ++++----
...port_with_dimension_and_metric_filters.php | 39 ++++++++++---------
...n_report_with_dimension_exclude_filter.php | 27 ++++++-------
.../src/run_report_with_dimension_filter.php | 27 ++++++-------
...n_report_with_dimension_in_list_filter.php | 27 ++++++-------
...report_with_multiple_dimension_filters.php | 29 +++++++-------
.../run_report_with_multiple_dimensions.php | 19 ++++-----
.../src/run_report_with_multiple_metrics.php | 19 ++++-----
.../src/run_report_with_named_date_ranges.php | 17 ++++----
.../src/run_report_with_ordering.php | 23 +++++------
.../src/run_report_with_pagination.php | 25 ++++++------
.../src/run_report_with_property_quota.php | 19 ++++-----
analyticsdata/test/analyticsDataTest.php | 2 +-
27 files changed, 269 insertions(+), 249 deletions(-)
diff --git a/analyticsdata/composer.json b/analyticsdata/composer.json
index dcbb91fa17..bf045954a8 100644
--- a/analyticsdata/composer.json
+++ b/analyticsdata/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/analytics-data": "^0.9.0"
+ "google/analytics-data": "^0.11.0"
}
}
diff --git a/analyticsdata/quickstart.php b/analyticsdata/quickstart.php
index 16011b9cb0..a0357e434f 100644
--- a/analyticsdata/quickstart.php
+++ b/analyticsdata/quickstart.php
@@ -31,10 +31,11 @@
// [START analytics_data_quickstart]
require 'vendor/autoload.php';
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\RunReportRequest;
/**
* TODO(developer): Replace this variable with your Google Analytics 4
@@ -50,27 +51,23 @@
// [START analyticsdata_run_report]
// Make an API call.
-$response = $client->runReport([
- 'property' => 'properties/' . $property_id,
- 'dateRanges' => [
+$request = (new RunReportRequest())
+ ->setProperty('properties/' . $property_id)
+ ->setDateRanges([
new DateRange([
'start_date' => '2020-03-31',
'end_date' => 'today',
]),
- ],
- 'dimensions' => [new Dimension(
- [
+ ])
+ ->setDimensions([new Dimension([
'name' => 'city',
- ]
- ),
- ],
- 'metrics' => [new Metric(
- [
+ ]),
+ ])
+ ->setMetrics([new Metric([
'name' => 'activeUsers',
- ]
- )
- ]
-]);
+ ])
+ ]);
+$response = $client->runReport($request);
// [END analyticsdata_run_report]
// [START analyticsdata_run_report_response]
diff --git a/analyticsdata/quickstart_oauth2/index.php b/analyticsdata/quickstart_oauth2/index.php
index 6b1a97c8d5..d52a49022c 100644
--- a/analyticsdata/quickstart_oauth2/index.php
+++ b/analyticsdata/quickstart_oauth2/index.php
@@ -18,10 +18,11 @@
// [START analyticsdata_quickstart_oauth2]
require 'vendor/autoload.php';
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\ApiCore\ApiException;
use Google\Auth\OAuth2;
@@ -56,27 +57,23 @@
try {
// Make an API call.
$client = new BetaAnalyticsDataClient(['credentials' => $oauth]);
- $response = $client->runReport([
- 'property' => 'properties/' . $property_id,
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $property_id)
+ ->setDateRanges([
new DateRange([
'start_date' => '2020-03-31',
'end_date' => 'today',
]),
- ],
- 'dimensions' => [new Dimension(
- [
+ ])
+ ->setDimensions([new Dimension([
'name' => 'city',
- ]
- ),
- ],
- 'metrics' => [new Metric(
- [
+ ]),
+ ])
+ ->setMetrics([new Metric([
'name' => 'activeUsers',
- ]
- )
- ]
- ]);
+ ])
+ ]);
+ $response = $client->runReport($request);
// Print results of an API call.
print 'Report result:
';
diff --git a/analyticsdata/src/client_from_json_credentials.php b/analyticsdata/src/client_from_json_credentials.php
index b3c289d734..8e46e99985 100644
--- a/analyticsdata/src/client_from_json_credentials.php
+++ b/analyticsdata/src/client_from_json_credentials.php
@@ -26,7 +26,7 @@
* $analyticsDataClient = require 'src/client_from_json_credentials.php';
* ```
*/
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
// [START analyticsdata_json_credentials_initialize]
/**
diff --git a/analyticsdata/src/get_common_metadata.php b/analyticsdata/src/get_common_metadata.php
index 73efa5bab3..5a8d9a1141 100644
--- a/analyticsdata/src/get_common_metadata.php
+++ b/analyticsdata/src/get_common_metadata.php
@@ -28,7 +28,8 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_get_common_metadata]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\GetMetadataRequest;
use Google\Analytics\Data\V1beta\Metadata;
use Google\ApiCore\ApiException;
@@ -50,7 +51,9 @@ function get_common_metadata()
// Make an API call.
try {
- $response = $client->getMetadata($formattedName);
+ $request = (new GetMetadataRequest())
+ ->setName($formattedName);
+ $response = $client->getMetadata($request);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
diff --git a/analyticsdata/src/get_metadata_by_property_id.php b/analyticsdata/src/get_metadata_by_property_id.php
index 34bb9fcbc5..3d58c0b26a 100644
--- a/analyticsdata/src/get_metadata_by_property_id.php
+++ b/analyticsdata/src/get_metadata_by_property_id.php
@@ -28,7 +28,8 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_get_metadata_by_property_id]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\GetMetadataRequest;
use Google\Analytics\Data\V1beta\Metadata;
use Google\ApiCore\ApiException;
@@ -46,7 +47,9 @@ function get_metadata_by_property_id(string $propertyId)
// Make an API call.
try {
- $response = $client->getMetadata($formattedName);
+ $request = (new GetMetadataRequest())
+ ->setName($formattedName);
+ $response = $client->getMetadata($request);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
diff --git a/analyticsdata/src/run_batch_report.php b/analyticsdata/src/run_batch_report.php
index 53d3ec14a4..5f6cdcf076 100644
--- a/analyticsdata/src/run_batch_report.php
+++ b/analyticsdata/src/run_batch_report.php
@@ -28,7 +28,8 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_batch_report]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\BatchRunReportsRequest;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
@@ -46,9 +47,9 @@ function run_batch_report(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->batchRunReports([
- 'property' => 'properties/' . $propertyId,
- 'requests' => [
+ $request = (new BatchRunReportsRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setRequests([
new RunReportRequest([
'dimensions' => [
new Dimension(['name' => 'country']),
@@ -71,8 +72,8 @@ function run_batch_report(string $propertyId)
]),
],
]),
- ],
- ]);
+ ]);
+ $response = $client->batchRunReports($request);
print 'Batch report results' . PHP_EOL;
foreach ($response->getReports() as $report) {
diff --git a/analyticsdata/src/run_pivot_report.php b/analyticsdata/src/run_pivot_report.php
index eb5c7f5700..b7e1cc53f7 100644
--- a/analyticsdata/src/run_pivot_report.php
+++ b/analyticsdata/src/run_pivot_report.php
@@ -28,14 +28,15 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_pivot_report]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\Pivot;
use Google\Analytics\Data\V1beta\OrderBy;
use Google\Analytics\Data\V1beta\OrderBy\DimensionOrderBy;
use Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy;
+use Google\Analytics\Data\V1beta\Pivot;
+use Google\Analytics\Data\V1beta\RunPivotReportRequest;
use Google\Analytics\Data\V1beta\RunPivotReportResponse;
/**
@@ -49,14 +50,14 @@ function run_pivot_report(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runPivotReport([
- 'property' => 'properties/' . $propertyId,
- 'dateRanges' => [new DateRange([
+ $request = (new RunPivotReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDateRanges([new DateRange([
'start_date' => '2021-01-01',
'end_date' => '2021-01-30',
]),
- ],
- 'pivots' => [
+ ])
+ ->setPivots([
new Pivot([
'field_names' => ['country'],
'limit' => 250,
@@ -77,13 +78,13 @@ function run_pivot_report(string $propertyId)
'desc' => true,
])],
]),
- ],
- 'metrics' => [new Metric(['name' => 'sessions'])],
- 'dimensions' => [
+ ])
+ ->setMetrics([new Metric(['name' => 'sessions'])])
+ ->setDimensions([
new Dimension(['name' => 'country']),
new Dimension(['name' => 'browser']),
- ],
- ]);
+ ]);
+ $response = $client->runPivotReport($request);
printPivotReportResponse($response);
}
diff --git a/analyticsdata/src/run_realtime_report.php b/analyticsdata/src/run_realtime_report.php
index 6c0e478eeb..f8d93a887f 100644
--- a/analyticsdata/src/run_realtime_report.php
+++ b/analyticsdata/src/run_realtime_report.php
@@ -28,10 +28,11 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_realtime_report]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;
/**
@@ -44,11 +45,11 @@ function run_realtime_report(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runRealtimeReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'country'])],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- ]);
+ $request = (new RunRealtimeReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'country'])])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])]);
+ $response = $client->runRealtimeReport($request);
printRunRealtimeReportResponse($response);
}
diff --git a/analyticsdata/src/run_realtime_report_with_multiple_dimensions.php b/analyticsdata/src/run_realtime_report_with_multiple_dimensions.php
index 94cfa1097f..c1d4440a05 100644
--- a/analyticsdata/src/run_realtime_report_with_multiple_dimensions.php
+++ b/analyticsdata/src/run_realtime_report_with_multiple_dimensions.php
@@ -28,10 +28,11 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_realtime_report_with_multiple_dimensions]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;
/**
@@ -44,14 +45,14 @@ function run_realtime_report_with_multiple_dimensions(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runRealtimeReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [
+ $request = (new RunRealtimeReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([
new Dimension(['name' => 'country']),
new Dimension(['name' => 'city']),
- ],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- ]);
+ ])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])]);
+ $response = $client->runRealtimeReport($request);
printRunRealtimeReportWithMultipleDimensionsResponse($response);
}
diff --git a/analyticsdata/src/run_realtime_report_with_multiple_metrics.php b/analyticsdata/src/run_realtime_report_with_multiple_metrics.php
index 3af8275ed2..478437efe3 100644
--- a/analyticsdata/src/run_realtime_report_with_multiple_metrics.php
+++ b/analyticsdata/src/run_realtime_report_with_multiple_metrics.php
@@ -28,10 +28,11 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_realtime_report_with_multiple_metrics]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunRealtimeReportRequest;
use Google\Analytics\Data\V1beta\RunRealtimeReportResponse;
/**
@@ -44,14 +45,14 @@ function run_realtime_report_with_multiple_metrics(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runRealtimeReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'unifiedScreenName'])],
- 'metrics' => [
+ $request = (new RunRealtimeReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'unifiedScreenName'])])
+ ->setMetrics([
new Metric(['name' => 'screenPageViews']),
new Metric(['name' => 'conversions']),
- ],
- ]);
+ ]);
+ $response = $client->runRealtimeReport($request);
printRunRealtimeReportWithMultipleMetricsResponse($response);
}
diff --git a/analyticsdata/src/run_report.php b/analyticsdata/src/run_report.php
index 2222201b6a..22611dcb34 100644
--- a/analyticsdata/src/run_report.php
+++ b/analyticsdata/src/run_report.php
@@ -25,11 +25,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -41,25 +42,25 @@ function run_report(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDateRanges([
new DateRange([
'start_date' => '2020-09-01',
'end_date' => '2020-09-15',
]),
- ],
- 'dimensions' => [
+ ])
+ ->setDimensions([
new Dimension([
'name' => 'country',
]),
- ],
- 'metrics' => [
+ ])
+ ->setMetrics([
new Metric([
'name' => 'activeUsers',
]),
- ],
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponse($response);
}
diff --git a/analyticsdata/src/run_report_with_aggregations.php b/analyticsdata/src/run_report_with_aggregations.php
index a51870e3c7..206dbc0a1c 100644
--- a/analyticsdata/src/run_report_with_aggregations.php
+++ b/analyticsdata/src/run_report_with_aggregations.php
@@ -28,12 +28,13 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_aggregations]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\MetricAggregation;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -47,22 +48,22 @@ function run_report_with_aggregations(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'country'])],
- 'metrics' => [new Metric(['name' => 'sessions'])],
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'country'])])
+ ->setMetrics([new Metric(['name' => 'sessions'])])
+ ->setDateRanges([
new DateRange([
'start_date' => '365daysAgo',
'end_date' => 'today',
]),
- ],
- 'metricAggregations' => [
+ ])
+ ->setMetricAggregations([
MetricAggregation::TOTAL,
MetricAggregation::MAXIMUM,
MetricAggregation::MINIMUM
- ]
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponseWithAggregations($response);
}
diff --git a/analyticsdata/src/run_report_with_cohorts.php b/analyticsdata/src/run_report_with_cohorts.php
index 0b064d0494..625183e786 100644
--- a/analyticsdata/src/run_report_with_cohorts.php
+++ b/analyticsdata/src/run_report_with_cohorts.php
@@ -28,14 +28,15 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_cohorts]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Cohort;
+use Google\Analytics\Data\V1beta\CohortSpec;
+use Google\Analytics\Data\V1beta\CohortsRange;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\CohortSpec;
-use Google\Analytics\Data\V1beta\CohortsRange;
-use Google\Analytics\Data\V1beta\Cohort;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -50,20 +51,20 @@ function run_report_with_cohorts(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([
new Dimension(['name' => 'cohort']),
new Dimension(['name' => 'cohortNthWeek']),
- ],
- 'metrics' => [
+ ])
+ ->setMetrics([
new Metric(['name' => 'cohortActiveUsers']),
new Metric([
'name' => 'cohortRetentionRate',
'expression' => 'cohortActiveUsers/cohortTotalUsers'
])
- ],
- 'cohortSpec' => new CohortSpec([
+ ])
+ ->setCohortSpec(new CohortSpec([
'cohorts' => [
new Cohort([
'dimension' => 'firstSessionDate',
@@ -79,8 +80,8 @@ function run_report_with_cohorts(string $propertyId)
'end_offset' => '4',
'granularity' => '2',
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithCohorts($response);
}
diff --git a/analyticsdata/src/run_report_with_date_ranges.php b/analyticsdata/src/run_report_with_date_ranges.php
index c163640808..a75f6eca82 100644
--- a/analyticsdata/src/run_report_with_date_ranges.php
+++ b/analyticsdata/src/run_report_with_date_ranges.php
@@ -28,11 +28,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_date_ranges]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -45,9 +46,9 @@ function run_report_with_date_ranges(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDateRanges([
new DateRange([
'start_date' => '2019-08-01',
'end_date' => '2019-08-14',
@@ -56,10 +57,10 @@ function run_report_with_date_ranges(string $propertyId)
'start_date' => '2020-08-01',
'end_date' => '2020-08-14',
]),
- ],
- 'dimensions' => [new Dimension(['name' => 'platform'])],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- ]);
+ ])
+ ->setDimensions([new Dimension(['name' => 'platform'])])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])]);
+ $response = $client->runReport($request);
printRunReportResponseWithDateRanges($response);
}
diff --git a/analyticsdata/src/run_report_with_dimension_and_metric_filters.php b/analyticsdata/src/run_report_with_dimension_and_metric_filters.php
index 225a12ba39..2c175a4760 100644
--- a/analyticsdata/src/run_report_with_dimension_and_metric_filters.php
+++ b/analyticsdata/src/run_report_with_dimension_and_metric_filters.php
@@ -28,19 +28,20 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_dimension_and_metric_filters]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
-use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\NumericValue;
-use Google\Analytics\Data\V1beta\FilterExpression;
-use Google\Analytics\Data\V1beta\FilterExpressionList;
use Google\Analytics\Data\V1beta\Filter;
-use Google\Analytics\Data\V1beta\Filter\StringFilter;
-use Google\Analytics\Data\V1beta\Filter\StringFilter\MatchType;
use Google\Analytics\Data\V1beta\Filter\NumericFilter;
use Google\Analytics\Data\V1beta\Filter\NumericFilter\Operation;
+use Google\Analytics\Data\V1beta\Filter\StringFilter;
+use Google\Analytics\Data\V1beta\Filter\StringFilter\MatchType;
+use Google\Analytics\Data\V1beta\FilterExpression;
+use Google\Analytics\Data\V1beta\FilterExpressionList;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\NumericValue;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -56,16 +57,16 @@ function run_report_with_dimension_and_metric_filters(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'city'])],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- 'dateRanges' => [new DateRange([
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'city'])])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])])
+ ->setDateRanges([new DateRange([
'start_date' => '2020-03-31',
'end_date' => 'today',
]),
- ],
- 'metricFilter' => new FilterExpression([
+ ])
+ ->setMetricFilter(new FilterExpression([
'filter' => new Filter([
'field_name' => 'sessions',
'numeric_filter' => new NumericFilter([
@@ -75,8 +76,8 @@ function run_report_with_dimension_and_metric_filters(string $propertyId)
]),
]),
]),
- ]),
- 'dimensionFilter' => new FilterExpression([
+ ]))
+ ->setDimensionFilter(new FilterExpression([
'and_group' => new FilterExpressionList([
'expressions' => [
new FilterExpression([
@@ -99,8 +100,8 @@ function run_report_with_dimension_and_metric_filters(string $propertyId)
]),
],
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithDimensionAndMetricFilters($response);
}
diff --git a/analyticsdata/src/run_report_with_dimension_exclude_filter.php b/analyticsdata/src/run_report_with_dimension_exclude_filter.php
index 101e813bd5..de5c7b8217 100644
--- a/analyticsdata/src/run_report_with_dimension_exclude_filter.php
+++ b/analyticsdata/src/run_report_with_dimension_exclude_filter.php
@@ -28,14 +28,15 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_dimension_exclude_filter]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
-use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\FilterExpression;
use Google\Analytics\Data\V1beta\Filter;
use Google\Analytics\Data\V1beta\Filter\StringFilter;
+use Google\Analytics\Data\V1beta\FilterExpression;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -52,16 +53,16 @@ function run_report_with_dimension_exclude_filter(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'pageTitle'])],
- 'metrics' => [new Metric(['name' => 'sessions'])],
- 'dateRanges' => [new DateRange([
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'pageTitle'])])
+ ->setMetrics([new Metric(['name' => 'sessions'])])
+ ->setDateRanges([new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'yesterday',
])
- ],
- 'dimensionFilter' => new FilterExpression([
+ ])
+ ->setDimensionFilter(new FilterExpression([
'not_expression' => new FilterExpression([
'filter' => new Filter([
'field_name' => 'pageTitle',
@@ -70,8 +71,8 @@ function run_report_with_dimension_exclude_filter(string $propertyId)
]),
]),
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithDimensionExcludeFilter($response);
}
diff --git a/analyticsdata/src/run_report_with_dimension_filter.php b/analyticsdata/src/run_report_with_dimension_filter.php
index 9038c55bb8..9a375fa76a 100644
--- a/analyticsdata/src/run_report_with_dimension_filter.php
+++ b/analyticsdata/src/run_report_with_dimension_filter.php
@@ -28,14 +28,15 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_dimension_filter]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
-use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\FilterExpression;
use Google\Analytics\Data\V1beta\Filter;
use Google\Analytics\Data\V1beta\Filter\StringFilter;
+use Google\Analytics\Data\V1beta\FilterExpression;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -52,25 +53,25 @@ function run_report_with_dimension_filter(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'date'])],
- 'metrics' => [new Metric(['name' => 'eventCount'])],
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'date'])])
+ ->setMetrics([new Metric(['name' => 'eventCount'])])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'yesterday',
])
- ],
- 'dimensionFilter' => new FilterExpression([
+ ])
+ ->setDimensionFilter(new FilterExpression([
'filter' => new Filter([
'field_name' => 'eventName',
'string_filter' => new StringFilter([
'value' => 'first_open'
]),
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithDimensionFilter($response);
}
diff --git a/analyticsdata/src/run_report_with_dimension_in_list_filter.php b/analyticsdata/src/run_report_with_dimension_in_list_filter.php
index 7d0f61ce90..9ad6001d80 100644
--- a/analyticsdata/src/run_report_with_dimension_in_list_filter.php
+++ b/analyticsdata/src/run_report_with_dimension_in_list_filter.php
@@ -28,14 +28,15 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_dimension_in_list_filter]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
-use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\FilterExpression;
use Google\Analytics\Data\V1beta\Filter;
use Google\Analytics\Data\V1beta\Filter\InListFilter;
+use Google\Analytics\Data\V1beta\FilterExpression;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -53,16 +54,16 @@ function run_report_with_dimension_in_list_filter(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'eventName'])],
- 'metrics' => [new Metric(['name' => 'sessions'])],
- 'dateRanges' => [new DateRange([
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'eventName'])])
+ ->setMetrics([new Metric(['name' => 'sessions'])])
+ ->setDateRanges([new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'yesterday',
])
- ],
- 'dimensionFilter' => new FilterExpression([
+ ])
+ ->setDimensionFilter(new FilterExpression([
'filter' => new Filter([
'field_name' => 'eventName',
'in_list_filter' => new InListFilter([
@@ -73,8 +74,8 @@ function run_report_with_dimension_in_list_filter(string $propertyId)
],
]),
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithDimensionInListFilter($response);
}
diff --git a/analyticsdata/src/run_report_with_multiple_dimension_filters.php b/analyticsdata/src/run_report_with_multiple_dimension_filters.php
index e95de130bb..5946048ac3 100644
--- a/analyticsdata/src/run_report_with_multiple_dimension_filters.php
+++ b/analyticsdata/src/run_report_with_multiple_dimension_filters.php
@@ -28,15 +28,16 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_multiple_dimension_filters]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
-use Google\Analytics\Data\V1beta\Metric;
-use Google\Analytics\Data\V1beta\MetricType;
-use Google\Analytics\Data\V1beta\FilterExpression;
-use Google\Analytics\Data\V1beta\FilterExpressionList;
use Google\Analytics\Data\V1beta\Filter;
use Google\Analytics\Data\V1beta\Filter\StringFilter;
+use Google\Analytics\Data\V1beta\FilterExpression;
+use Google\Analytics\Data\V1beta\FilterExpressionList;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -54,17 +55,17 @@ function run_report_with_multiple_dimension_filters(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'browser'])],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'browser'])])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'yesterday',
]),
- ],
- 'dimensionFilter' => new FilterExpression([
+ ])
+ ->setDimensionFilter(new FilterExpression([
'and_group' => new FilterExpressionList([
'expressions' => [
new FilterExpression([
@@ -85,8 +86,8 @@ function run_report_with_multiple_dimension_filters(string $propertyId)
]),
],
]),
- ]),
- ]);
+ ]));
+ $response = $client->runReport($request);
printRunReportResponseWithMultipleDimensionFilters($response);
}
diff --git a/analyticsdata/src/run_report_with_multiple_dimensions.php b/analyticsdata/src/run_report_with_multiple_dimensions.php
index 5a71e23a31..c0e540f032 100644
--- a/analyticsdata/src/run_report_with_multiple_dimensions.php
+++ b/analyticsdata/src/run_report_with_multiple_dimensions.php
@@ -28,11 +28,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_multiple_dimensions]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -45,21 +46,21 @@ function run_report_with_multiple_dimensions(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([
new Dimension(['name' => 'country']),
new Dimension(['name' => 'region']),
new Dimension(['name' => 'city']),
- ],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- 'dateRanges' => [
+ ])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'today',
])
- ],
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponseWithMultipleDimensions($response);
}
diff --git a/analyticsdata/src/run_report_with_multiple_metrics.php b/analyticsdata/src/run_report_with_multiple_metrics.php
index 928e253c4d..d6c8e2c260 100644
--- a/analyticsdata/src/run_report_with_multiple_metrics.php
+++ b/analyticsdata/src/run_report_with_multiple_metrics.php
@@ -28,11 +28,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_multiple_metrics]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -45,21 +46,21 @@ function run_report_with_multiple_metrics(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'date'])],
- 'metrics' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'date'])])
+ ->setMetrics([
new Metric(['name' => 'activeUsers']),
new Metric(['name' => 'newUsers']),
new Metric(['name' => 'totalRevenue'])
- ],
- 'dateRanges' => [
+ ])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'today',
])
- ],
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponseWithMultipleMetrics($response);
}
diff --git a/analyticsdata/src/run_report_with_named_date_ranges.php b/analyticsdata/src/run_report_with_named_date_ranges.php
index 19099c9395..9d0357fce8 100644
--- a/analyticsdata/src/run_report_with_named_date_ranges.php
+++ b/analyticsdata/src/run_report_with_named_date_ranges.php
@@ -28,11 +28,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_named_date_ranges]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -45,9 +46,9 @@ function run_report_with_named_date_ranges(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDateRanges([
new DateRange([
'start_date' => '2020-01-01',
'end_date' => '2020-01-31',
@@ -58,10 +59,10 @@ function run_report_with_named_date_ranges(string $propertyId)
'end_date' => '2021-01-31',
'name' => 'current_year',
]),
- ],
- 'dimensions' => [new Dimension(['name' => 'country'])],
- 'metrics' => [new Metric(['name' => 'sessions'])],
- ]);
+ ])
+ ->setDimensions([new Dimension(['name' => 'country'])])
+ ->setMetrics([new Metric(['name' => 'sessions'])]);
+ $response = $client->runReport($request);
printRunReportResponseWithNamedDateRanges($response);
}
diff --git a/analyticsdata/src/run_report_with_ordering.php b/analyticsdata/src/run_report_with_ordering.php
index 6e6cf9016e..0f578cbab1 100644
--- a/analyticsdata/src/run_report_with_ordering.php
+++ b/analyticsdata/src/run_report_with_ordering.php
@@ -28,13 +28,14 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_ordering]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
use Google\Analytics\Data\V1beta\OrderBy;
use Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -48,29 +49,29 @@ function run_report_with_ordering(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dimensions' => [new Dimension(['name' => 'date'])],
- 'metrics' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDimensions([new Dimension(['name' => 'date'])])
+ ->setMetrics([
new Metric(['name' => 'activeUsers']),
new Metric(['name' => 'newUsers']),
new Metric(['name' => 'totalRevenue']),
- ],
- 'dateRanges' => [
+ ])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'today',
]),
- ],
- 'orderBys' => [
+ ])
+ ->setOrderBys([
new OrderBy([
'metric' => new MetricOrderBy([
'metric_name' => 'totalRevenue',
]),
'desc' => true,
]),
- ],
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponseWithOrdering($response);
}
diff --git a/analyticsdata/src/run_report_with_pagination.php b/analyticsdata/src/run_report_with_pagination.php
index f6d242cc43..32fcf7fbae 100644
--- a/analyticsdata/src/run_report_with_pagination.php
+++ b/analyticsdata/src/run_report_with_pagination.php
@@ -28,11 +28,12 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_pagination]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -46,27 +47,27 @@ function run_report_with_pagination(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setDateRanges([
new DateRange([
'start_date' => '350daysAgo',
'end_date' => 'yesterday',
])
- ],
- 'dimensions' => [
+ ])
+ ->setDimensions([
new Dimension(['name' => 'firstUserSource']),
new Dimension(['name' => 'firstUserMedium']),
new Dimension(['name' => 'firstUserCampaignName']),
- ],
- 'metrics' => [
+ ])
+ ->setMetrics([
new Metric(['name' => 'sessions']),
new Metric(['name' => 'conversions']),
new Metric(['name' => 'totalRevenue']),
- ],
- 'limit' => 100000,
- 'offset' => 0,
- ]);
+ ])
+ ->setLimit(100000)
+ ->setOffset(0);
+ $response = $client->runReport($request);
printRunReportResponseWithPagination($response);
}
diff --git a/analyticsdata/src/run_report_with_property_quota.php b/analyticsdata/src/run_report_with_property_quota.php
index 8f690620cc..056f08ef84 100644
--- a/analyticsdata/src/run_report_with_property_quota.php
+++ b/analyticsdata/src/run_report_with_property_quota.php
@@ -28,10 +28,11 @@
namespace Google\Cloud\Samples\Analytics\Data;
// [START analyticsdata_run_report_with_property_quota]
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\RunReportRequest;
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
@@ -44,18 +45,18 @@ function run_report_with_property_quota(string $propertyId)
$client = new BetaAnalyticsDataClient();
// Make an API call.
- $response = $client->runReport([
- 'property' => 'properties/' . $propertyId,
- 'returnPropertyQuota' => true,
- 'dimensions' => [new Dimension(['name' => 'country'])],
- 'metrics' => [new Metric(['name' => 'activeUsers'])],
- 'dateRanges' => [
+ $request = (new RunReportRequest())
+ ->setProperty('properties/' . $propertyId)
+ ->setReturnPropertyQuota(true)
+ ->setDimensions([new Dimension(['name' => 'country'])])
+ ->setMetrics([new Metric(['name' => 'activeUsers'])])
+ ->setDateRanges([
new DateRange([
'start_date' => '7daysAgo',
'end_date' => 'today',
]),
- ],
- ]);
+ ]);
+ $response = $client->runReport($request);
printRunReportResponseWithPropertyQuota($response);
}
diff --git a/analyticsdata/test/analyticsDataTest.php b/analyticsdata/test/analyticsDataTest.php
index eb06bd52ca..8ed8a7eac8 100644
--- a/analyticsdata/test/analyticsDataTest.php
+++ b/analyticsdata/test/analyticsDataTest.php
@@ -20,7 +20,7 @@
use Google\ApiCore\ValidationException;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
-use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
class analyticsDataTest extends TestCase
{
From ff03a0ddcc1dcc144802c0be9972cf95397aa076 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:07:43 -0600
Subject: [PATCH 048/285] chore: upgrade errorreporting samples to new GAPIC
(#1872)
---
error_reporting/composer.json | 2 +-
error_reporting/src/report_error.php | 8 ++++++--
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/error_reporting/composer.json b/error_reporting/composer.json
index 108185924f..7bedb46b9a 100644
--- a/error_reporting/composer.json
+++ b/error_reporting/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-error-reporting": "^0.19.0"
+ "google/cloud-error-reporting": "^0.20.2"
}
}
diff --git a/error_reporting/src/report_error.php b/error_reporting/src/report_error.php
index 401c92b0d3..2608c25055 100644
--- a/error_reporting/src/report_error.php
+++ b/error_reporting/src/report_error.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\ErrorReporting;
# [START report_error]
-use Google\Cloud\ErrorReporting\V1beta1\ReportErrorsServiceClient;
+use Google\Cloud\ErrorReporting\V1beta1\Client\ReportErrorsServiceClient;
use Google\Cloud\ErrorReporting\V1beta1\ErrorContext;
use Google\Cloud\ErrorReporting\V1beta1\ReportedErrorEvent;
+use Google\Cloud\ErrorReporting\V1beta1\ReportErrorEventRequest;
use Google\Cloud\ErrorReporting\V1beta1\SourceLocation;
/**
@@ -53,8 +54,11 @@ function report_error(string $projectId, string $message, string $user = '')
$event = (new ReportedErrorEvent())
->setMessage($message)
->setContext($context);
+ $request = (new ReportErrorEventRequest())
+ ->setProjectName($projectName)
+ ->setEvent($event);
- $errors->reportErrorEvent($projectName, $event);
+ $errors->reportErrorEvent($request);
print('Reported an exception to Stackdriver' . PHP_EOL);
}
# [END report_error]
From 8d6237771bdcf9566449d42106adc48ea88fef7d Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:07:52 -0600
Subject: [PATCH 049/285] chore: upgrade videostitcher samples to new GAPIC
(#1871)
---
media/videostitcher/src/create_cdn_key.php | 9 +++++++--
media/videostitcher/src/create_cdn_key_akamai.php | 11 ++++++++---
media/videostitcher/src/create_live_config.php | 9 +++++++--
media/videostitcher/src/create_live_session.php | 8 ++++++--
media/videostitcher/src/create_slate.php | 9 +++++++--
media/videostitcher/src/create_vod_session.php | 8 ++++++--
media/videostitcher/src/delete_cdn_key.php | 7 +++++--
media/videostitcher/src/delete_live_config.php | 7 +++++--
media/videostitcher/src/delete_slate.php | 7 +++++--
media/videostitcher/src/get_cdn_key.php | 7 +++++--
media/videostitcher/src/get_live_ad_tag_detail.php | 7 +++++--
media/videostitcher/src/get_live_config.php | 7 +++++--
media/videostitcher/src/get_live_session.php | 7 +++++--
media/videostitcher/src/get_slate.php | 7 +++++--
media/videostitcher/src/get_vod_ad_tag_detail.php | 7 +++++--
media/videostitcher/src/get_vod_session.php | 7 +++++--
media/videostitcher/src/get_vod_stitch_detail.php | 7 +++++--
media/videostitcher/src/list_cdn_keys.php | 7 +++++--
media/videostitcher/src/list_live_ad_tag_details.php | 7 +++++--
media/videostitcher/src/list_live_configs.php | 7 +++++--
media/videostitcher/src/list_slates.php | 7 +++++--
media/videostitcher/src/list_vod_ad_tag_details.php | 7 +++++--
media/videostitcher/src/list_vod_stitch_details.php | 7 +++++--
media/videostitcher/src/update_cdn_key.php | 8 ++++++--
media/videostitcher/src/update_cdn_key_akamai.php | 10 +++++++---
media/videostitcher/src/update_slate.php | 8 ++++++--
26 files changed, 145 insertions(+), 54 deletions(-)
diff --git a/media/videostitcher/src/create_cdn_key.php b/media/videostitcher/src/create_cdn_key.php
index 05b4361d7b..4dba07114c 100644
--- a/media/videostitcher/src/create_cdn_key.php
+++ b/media/videostitcher/src/create_cdn_key.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_cdn_key]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\CdnKey;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateCdnKeyRequest;
use Google\Cloud\Video\Stitcher\V1\GoogleCdnKey;
use Google\Cloud\Video\Stitcher\V1\MediaCdnKey;
@@ -75,7 +76,11 @@ function create_cdn_key(
$cloudCdn->setPrivateKey($privateKey);
// Run CDN key creation request
- $operationResponse = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
+ $request = (new CreateCdnKeyRequest())
+ ->setParent($parent)
+ ->setCdnKey($cdnKey)
+ ->setCdnKeyId($cdnKeyId);
+ $operationResponse = $stitcherClient->createCdnKey($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/create_cdn_key_akamai.php b/media/videostitcher/src/create_cdn_key_akamai.php
index 146ace93e3..fb1dcda99f 100644
--- a/media/videostitcher/src/create_cdn_key_akamai.php
+++ b/media/videostitcher/src/create_cdn_key_akamai.php
@@ -25,9 +25,10 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_cdn_key_akamai]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
-use Google\Cloud\Video\Stitcher\V1\CdnKey;
use Google\Cloud\Video\Stitcher\V1\AkamaiCdnKey;
+use Google\Cloud\Video\Stitcher\V1\CdnKey;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateCdnKeyRequest;
/**
* Creates an Akamai CDN key.
@@ -57,7 +58,11 @@ function create_cdn_key_akamai(
$cdnKey->setAkamaiCdnKey($cloudCdn);
// Run CDN key creation request
- $operationResponse = $stitcherClient->createCdnKey($parent, $cdnKey, $cdnKeyId);
+ $request = (new CreateCdnKeyRequest())
+ ->setParent($parent)
+ ->setCdnKey($cdnKey)
+ ->setCdnKeyId($cdnKeyId);
+ $operationResponse = $stitcherClient->createCdnKey($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/create_live_config.php b/media/videostitcher/src/create_live_config.php
index 807cdcca52..d87d3a0d63 100644
--- a/media/videostitcher/src/create_live_config.php
+++ b/media/videostitcher/src/create_live_config.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_live_config]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\AdTracking;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateLiveConfigRequest;
use Google\Cloud\Video\Stitcher\V1\LiveConfig;
/**
@@ -66,7 +67,11 @@ function create_live_config(
->setDefaultSlate($defaultSlate);
// Run live config creation request
- $operationResponse = $stitcherClient->createLiveConfig($parent, $liveConfigId, $liveConfig);
+ $request = (new CreateLiveConfigRequest())
+ ->setParent($parent)
+ ->setLiveConfigId($liveConfigId)
+ ->setLiveConfig($liveConfig);
+ $operationResponse = $stitcherClient->createLiveConfig($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/create_live_session.php b/media/videostitcher/src/create_live_session.php
index 06ef787457..ae24fdf563 100644
--- a/media/videostitcher/src/create_live_session.php
+++ b/media/videostitcher/src/create_live_session.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_live_session]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateLiveSessionRequest;
use Google\Cloud\Video\Stitcher\V1\LiveSession;
/**
@@ -51,7 +52,10 @@ function create_live_session(
$liveSession->setLiveConfig($liveConfig);
// Run live session creation request
- $response = $stitcherClient->createLiveSession($parent, $liveSession);
+ $request = (new CreateLiveSessionRequest())
+ ->setParent($parent)
+ ->setLiveSession($liveSession);
+ $response = $stitcherClient->createLiveSession($request);
// Print results
printf('Live session: %s' . PHP_EOL, $response->getName());
diff --git a/media/videostitcher/src/create_slate.php b/media/videostitcher/src/create_slate.php
index 00dcb4f718..5255a9192e 100644
--- a/media/videostitcher/src/create_slate.php
+++ b/media/videostitcher/src/create_slate.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_slate]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateSlateRequest;
use Google\Cloud\Video\Stitcher\V1\Slate;
/**
@@ -50,7 +51,11 @@ function create_slate(
$slate->setUri($slateUri);
// Run slate creation request
- $operationResponse = $stitcherClient->createSlate($parent, $slateId, $slate);
+ $request = (new CreateSlateRequest())
+ ->setParent($parent)
+ ->setSlateId($slateId)
+ ->setSlate($slate);
+ $operationResponse = $stitcherClient->createSlate($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/create_vod_session.php b/media/videostitcher/src/create_vod_session.php
index 3d6c4cfa9f..7d9bd604e1 100644
--- a/media/videostitcher/src/create_vod_session.php
+++ b/media/videostitcher/src/create_vod_session.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_create_vod_session]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\AdTracking;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\CreateVodSessionRequest;
use Google\Cloud\Video\Stitcher\V1\VodSession;
/**
@@ -57,7 +58,10 @@ function create_vod_session(
$vodSession->setAdTracking(AdTracking::SERVER);
// Run VOD session creation request
- $response = $stitcherClient->createVodSession($parent, $vodSession);
+ $request = (new CreateVodSessionRequest())
+ ->setParent($parent)
+ ->setVodSession($vodSession);
+ $response = $stitcherClient->createVodSession($request);
// Print results
printf('VOD session: %s' . PHP_EOL, $response->getName());
diff --git a/media/videostitcher/src/delete_cdn_key.php b/media/videostitcher/src/delete_cdn_key.php
index 0366265f0a..5aff6ed847 100644
--- a/media/videostitcher/src/delete_cdn_key.php
+++ b/media/videostitcher/src/delete_cdn_key.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_delete_cdn_key]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\DeleteCdnKeyRequest;
/**
* Deletes a CDN key.
@@ -43,7 +44,9 @@ function delete_cdn_key(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->cdnKeyName($callingProjectId, $location, $cdnKeyId);
- $operationResponse = $stitcherClient->deleteCdnKey($formattedName);
+ $request = (new DeleteCdnKeyRequest())
+ ->setName($formattedName);
+ $operationResponse = $stitcherClient->deleteCdnKey($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print status
diff --git a/media/videostitcher/src/delete_live_config.php b/media/videostitcher/src/delete_live_config.php
index 4ebf8badb5..cca31ccb74 100644
--- a/media/videostitcher/src/delete_live_config.php
+++ b/media/videostitcher/src/delete_live_config.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_delete_live_config]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\DeleteLiveConfigRequest;
/**
* Deletes a live config.
@@ -43,7 +44,9 @@ function delete_live_config(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->liveConfigName($callingProjectId, $location, $liveConfigId);
- $operationResponse = $stitcherClient->deleteLiveConfig($formattedName);
+ $request = (new DeleteLiveConfigRequest())
+ ->setName($formattedName);
+ $operationResponse = $stitcherClient->deleteLiveConfig($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print status
diff --git a/media/videostitcher/src/delete_slate.php b/media/videostitcher/src/delete_slate.php
index 69576bd67f..eacca80d65 100644
--- a/media/videostitcher/src/delete_slate.php
+++ b/media/videostitcher/src/delete_slate.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_delete_slate]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\DeleteSlateRequest;
/**
* Deletes a slate.
@@ -43,7 +44,9 @@ function delete_slate(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->slateName($callingProjectId, $location, $slateId);
- $operationResponse = $stitcherClient->deleteSlate($formattedName);
+ $request = (new DeleteSlateRequest())
+ ->setName($formattedName);
+ $operationResponse = $stitcherClient->deleteSlate($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print status
diff --git a/media/videostitcher/src/get_cdn_key.php b/media/videostitcher/src/get_cdn_key.php
index 871349e30f..969cc59e3e 100644
--- a/media/videostitcher/src/get_cdn_key.php
+++ b/media/videostitcher/src/get_cdn_key.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_cdn_key]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetCdnKeyRequest;
/**
* Gets a CDN key.
@@ -43,7 +44,9 @@ function get_cdn_key(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->cdnKeyName($callingProjectId, $location, $cdnKeyId);
- $key = $stitcherClient->getCdnKey($formattedName);
+ $request = (new GetCdnKeyRequest())
+ ->setName($formattedName);
+ $key = $stitcherClient->getCdnKey($request);
// Print results
printf('CDN key: %s' . PHP_EOL, $key->getName());
diff --git a/media/videostitcher/src/get_live_ad_tag_detail.php b/media/videostitcher/src/get_live_ad_tag_detail.php
index 6b3896b019..a172779f19 100644
--- a/media/videostitcher/src/get_live_ad_tag_detail.php
+++ b/media/videostitcher/src/get_live_ad_tag_detail.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_live_ad_tag_detail]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetLiveAdTagDetailRequest;
/**
* Gets the specified ad tag detail for the live session.
@@ -45,7 +46,9 @@ function get_live_ad_tag_detail(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->liveAdTagDetailName($callingProjectId, $location, $sessionId, $adTagDetailId);
- $adTagDetail = $stitcherClient->getLiveAdTagDetail($formattedName);
+ $request = (new GetLiveAdTagDetailRequest())
+ ->setName($formattedName);
+ $adTagDetail = $stitcherClient->getLiveAdTagDetail($request);
// Print results
printf('Live ad tag detail: %s' . PHP_EOL, $adTagDetail->getName());
diff --git a/media/videostitcher/src/get_live_config.php b/media/videostitcher/src/get_live_config.php
index ac3a559a75..58d1d8c08b 100644
--- a/media/videostitcher/src/get_live_config.php
+++ b/media/videostitcher/src/get_live_config.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_live_config]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetLiveConfigRequest;
/**
* Gets a live config.
@@ -43,7 +44,9 @@ function get_live_config(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->liveConfigName($callingProjectId, $location, $liveConfigId);
- $liveConfig = $stitcherClient->getLiveConfig($formattedName);
+ $request = (new GetLiveConfigRequest())
+ ->setName($formattedName);
+ $liveConfig = $stitcherClient->getLiveConfig($request);
// Print results
printf('Live config: %s' . PHP_EOL, $liveConfig->getName());
diff --git a/media/videostitcher/src/get_live_session.php b/media/videostitcher/src/get_live_session.php
index 59043fd2a4..e2c28dc99c 100644
--- a/media/videostitcher/src/get_live_session.php
+++ b/media/videostitcher/src/get_live_session.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_live_session]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetLiveSessionRequest;
/**
* Gets a live session.
@@ -43,7 +44,9 @@ function get_live_session(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->liveSessionName($callingProjectId, $location, $sessionId);
- $session = $stitcherClient->getLiveSession($formattedName);
+ $request = (new GetLiveSessionRequest())
+ ->setName($formattedName);
+ $session = $stitcherClient->getLiveSession($request);
// Print results
printf('Live session: %s' . PHP_EOL, $session->getName());
diff --git a/media/videostitcher/src/get_slate.php b/media/videostitcher/src/get_slate.php
index e9b3c15a13..0b52a02e5e 100644
--- a/media/videostitcher/src/get_slate.php
+++ b/media/videostitcher/src/get_slate.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_slate]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetSlateRequest;
/**
* Gets a slate.
@@ -43,7 +44,9 @@ function get_slate(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->slateName($callingProjectId, $location, $slateId);
- $slate = $stitcherClient->getSlate($formattedName);
+ $request = (new GetSlateRequest())
+ ->setName($formattedName);
+ $slate = $stitcherClient->getSlate($request);
// Print results
printf('Slate: %s' . PHP_EOL, $slate->getName());
diff --git a/media/videostitcher/src/get_vod_ad_tag_detail.php b/media/videostitcher/src/get_vod_ad_tag_detail.php
index 81c3e4385a..88e5fbf8cc 100644
--- a/media/videostitcher/src/get_vod_ad_tag_detail.php
+++ b/media/videostitcher/src/get_vod_ad_tag_detail.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_vod_ad_tag_detail]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetVodAdTagDetailRequest;
/**
* Gets the specified ad tag detail for the VOD session.
@@ -45,7 +46,9 @@ function get_vod_ad_tag_detail(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->vodAdTagDetailName($callingProjectId, $location, $sessionId, $adTagDetailId);
- $adTagDetail = $stitcherClient->getVodAdTagDetail($formattedName);
+ $request = (new GetVodAdTagDetailRequest())
+ ->setName($formattedName);
+ $adTagDetail = $stitcherClient->getVodAdTagDetail($request);
// Print results
printf('VOD ad tag detail: %s' . PHP_EOL, $adTagDetail->getName());
diff --git a/media/videostitcher/src/get_vod_session.php b/media/videostitcher/src/get_vod_session.php
index 45daccc492..5af7db3501 100644
--- a/media/videostitcher/src/get_vod_session.php
+++ b/media/videostitcher/src/get_vod_session.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_vod_session]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetVodSessionRequest;
/**
* Gets a VOD session.
@@ -43,7 +44,9 @@ function get_vod_session(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->vodSessionName($callingProjectId, $location, $sessionId);
- $session = $stitcherClient->getVodSession($formattedName);
+ $request = (new GetVodSessionRequest())
+ ->setName($formattedName);
+ $session = $stitcherClient->getVodSession($request);
// Print results
printf('VOD session: %s' . PHP_EOL, $session->getName());
diff --git a/media/videostitcher/src/get_vod_stitch_detail.php b/media/videostitcher/src/get_vod_stitch_detail.php
index 31fc966434..ff79f41360 100644
--- a/media/videostitcher/src/get_vod_stitch_detail.php
+++ b/media/videostitcher/src/get_vod_stitch_detail.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_get_vod_stitch_detail]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\GetVodStitchDetailRequest;
/**
* Gets the specified stitch detail for the VOD session.
@@ -45,7 +46,9 @@ function get_vod_stitch_detail(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->vodStitchDetailName($callingProjectId, $location, $sessionId, $stitchDetailId);
- $stitchDetail = $stitcherClient->getVodStitchDetail($formattedName);
+ $request = (new GetVodStitchDetailRequest())
+ ->setName($formattedName);
+ $stitchDetail = $stitcherClient->getVodStitchDetail($request);
// Print results
printf('VOD stitch detail: %s' . PHP_EOL, $stitchDetail->getName());
diff --git a/media/videostitcher/src/list_cdn_keys.php b/media/videostitcher/src/list_cdn_keys.php
index 65176448d3..094427478c 100644
--- a/media/videostitcher/src/list_cdn_keys.php
+++ b/media/videostitcher/src/list_cdn_keys.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_cdn_keys]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListCdnKeysRequest;
/**
* Lists all CDN keys for a location.
@@ -41,7 +42,9 @@ function list_cdn_keys(
$stitcherClient = new VideoStitcherServiceClient();
$parent = $stitcherClient->locationName($callingProjectId, $location);
- $response = $stitcherClient->listCdnKeys($parent);
+ $request = (new ListCdnKeysRequest())
+ ->setParent($parent);
+ $response = $stitcherClient->listCdnKeys($request);
// Print the CDN key list.
$cdn_keys = $response->iterateAllElements();
diff --git a/media/videostitcher/src/list_live_ad_tag_details.php b/media/videostitcher/src/list_live_ad_tag_details.php
index ae0787f66d..058a5a91bb 100644
--- a/media/videostitcher/src/list_live_ad_tag_details.php
+++ b/media/videostitcher/src/list_live_ad_tag_details.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_live_ad_tag_details]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListLiveAdTagDetailsRequest;
/**
* Lists the ad tag details for the specified live session.
@@ -43,7 +44,9 @@ function list_live_ad_tag_details(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->liveSessionName($callingProjectId, $location, $sessionId);
- $response = $stitcherClient->listLiveAdTagDetails($formattedName);
+ $request = (new ListLiveAdTagDetailsRequest())
+ ->setParent($formattedName);
+ $response = $stitcherClient->listLiveAdTagDetails($request);
// Print the ad tag details list.
$adTagDetails = $response->iterateAllElements();
diff --git a/media/videostitcher/src/list_live_configs.php b/media/videostitcher/src/list_live_configs.php
index 6062fbcfa4..9f8b2c505b 100644
--- a/media/videostitcher/src/list_live_configs.php
+++ b/media/videostitcher/src/list_live_configs.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_live_configs]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListLiveConfigsRequest;
/**
* Lists all live configs for a location.
@@ -41,7 +42,9 @@ function list_live_configs(
$stitcherClient = new VideoStitcherServiceClient();
$parent = $stitcherClient->locationName($callingProjectId, $location);
- $response = $stitcherClient->listLiveConfigs($parent);
+ $request = (new ListLiveConfigsRequest())
+ ->setParent($parent);
+ $response = $stitcherClient->listLiveConfigs($request);
// Print the live config list.
$liveConfigs = $response->iterateAllElements();
diff --git a/media/videostitcher/src/list_slates.php b/media/videostitcher/src/list_slates.php
index 96fd0fabaf..8c44508095 100644
--- a/media/videostitcher/src/list_slates.php
+++ b/media/videostitcher/src/list_slates.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_slates]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListSlatesRequest;
/**
* Lists all slates for a location.
@@ -41,7 +42,9 @@ function list_slates(
$stitcherClient = new VideoStitcherServiceClient();
$parent = $stitcherClient->locationName($callingProjectId, $location);
- $response = $stitcherClient->listSlates($parent);
+ $request = (new ListSlatesRequest())
+ ->setParent($parent);
+ $response = $stitcherClient->listSlates($request);
// Print the slate list.
$slates = $response->iterateAllElements();
diff --git a/media/videostitcher/src/list_vod_ad_tag_details.php b/media/videostitcher/src/list_vod_ad_tag_details.php
index 91ea27ae27..ac943bfb36 100644
--- a/media/videostitcher/src/list_vod_ad_tag_details.php
+++ b/media/videostitcher/src/list_vod_ad_tag_details.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_vod_ad_tag_details]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListVodAdTagDetailsRequest;
/**
* Lists the ad tag details for the specified VOD session.
@@ -43,7 +44,9 @@ function list_vod_ad_tag_details(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->vodSessionName($callingProjectId, $location, $sessionId);
- $response = $stitcherClient->listVodAdTagDetails($formattedName);
+ $request = (new ListVodAdTagDetailsRequest())
+ ->setParent($formattedName);
+ $response = $stitcherClient->listVodAdTagDetails($request);
// Print the ad tag details list.
$adTagDetails = $response->iterateAllElements();
diff --git a/media/videostitcher/src/list_vod_stitch_details.php b/media/videostitcher/src/list_vod_stitch_details.php
index bf76972676..ab0823618a 100644
--- a/media/videostitcher/src/list_vod_stitch_details.php
+++ b/media/videostitcher/src/list_vod_stitch_details.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_list_vod_stitch_details]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\ListVodStitchDetailsRequest;
/**
* Lists the stitch details for the specified VOD session.
@@ -43,7 +44,9 @@ function list_vod_stitch_details(
$stitcherClient = new VideoStitcherServiceClient();
$formattedName = $stitcherClient->vodSessionName($callingProjectId, $location, $sessionId);
- $response = $stitcherClient->listVodStitchDetails($formattedName);
+ $request = (new ListVodStitchDetailsRequest())
+ ->setParent($formattedName);
+ $response = $stitcherClient->listVodStitchDetails($request);
// Print the stitch details list.
$stitchDetails = $response->iterateAllElements();
diff --git a/media/videostitcher/src/update_cdn_key.php b/media/videostitcher/src/update_cdn_key.php
index 0678c432ad..ba86c2ecd9 100644
--- a/media/videostitcher/src/update_cdn_key.php
+++ b/media/videostitcher/src/update_cdn_key.php
@@ -25,10 +25,11 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_update_cdn_key]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\CdnKey;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\GoogleCdnKey;
use Google\Cloud\Video\Stitcher\V1\MediaCdnKey;
+use Google\Cloud\Video\Stitcher\V1\UpdateCdnKeyRequest;
use Google\Protobuf\FieldMask;
/**
@@ -84,7 +85,10 @@ function update_cdn_key(
$cloudCdn->setPrivateKey($privateKey);
// Run CDN key creation request
- $operationResponse = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
+ $request = (new UpdateCdnKeyRequest())
+ ->setCdnKey($cdnKey)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $stitcherClient->updateCdnKey($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/update_cdn_key_akamai.php b/media/videostitcher/src/update_cdn_key_akamai.php
index ca0d9b7cfb..59a3966e3a 100644
--- a/media/videostitcher/src/update_cdn_key_akamai.php
+++ b/media/videostitcher/src/update_cdn_key_akamai.php
@@ -25,9 +25,10 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_update_cdn_key_akamai]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
-use Google\Cloud\Video\Stitcher\V1\CdnKey;
use Google\Cloud\Video\Stitcher\V1\AkamaiCdnKey;
+use Google\Cloud\Video\Stitcher\V1\CdnKey;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\UpdateCdnKeyRequest;
use Google\Protobuf\FieldMask;
/**
@@ -63,7 +64,10 @@ function update_cdn_key_akamai(
]);
// Run CDN key creation request
- $operationResponse = $stitcherClient->updateCdnKey($cdnKey, $updateMask);
+ $request = (new UpdateCdnKeyRequest())
+ ->setCdnKey($cdnKey)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $stitcherClient->updateCdnKey($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/videostitcher/src/update_slate.php b/media/videostitcher/src/update_slate.php
index 68681d6f3e..4c6d478476 100644
--- a/media/videostitcher/src/update_slate.php
+++ b/media/videostitcher/src/update_slate.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\Stitcher;
// [START videostitcher_update_slate]
-use Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient;
+use Google\Cloud\Video\Stitcher\V1\Client\VideoStitcherServiceClient;
use Google\Cloud\Video\Stitcher\V1\Slate;
+use Google\Cloud\Video\Stitcher\V1\UpdateSlateRequest;
use Google\Protobuf\FieldMask;
/**
@@ -55,7 +56,10 @@ function update_slate(
]);
// Run slate update request
- $operationResponse = $stitcherClient->updateSlate($slate, $updateMask);
+ $request = (new UpdateSlateRequest())
+ ->setSlate($slate)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $stitcherClient->updateSlate($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
From efdc6446987f7adf45fa7bd034088f996ad19f3d Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:08:00 -0600
Subject: [PATCH 050/285] chore: upgrade medialivestream samples to new GAPIC
(#1870)
---
media/livestream/composer.json | 2 +-
media/livestream/src/create_channel.php | 9 +++++++--
media/livestream/src/create_channel_event.php | 9 +++++++--
.../livestream/src/create_channel_with_backup_input.php | 9 +++++++--
media/livestream/src/create_input.php | 9 +++++++--
media/livestream/src/delete_channel.php | 7 +++++--
media/livestream/src/delete_channel_event.php | 7 +++++--
media/livestream/src/delete_input.php | 7 +++++--
media/livestream/src/get_channel.php | 7 +++++--
media/livestream/src/get_channel_event.php | 7 +++++--
media/livestream/src/get_input.php | 7 +++++--
media/livestream/src/list_channel_events.php | 7 +++++--
media/livestream/src/list_channels.php | 7 +++++--
media/livestream/src/list_inputs.php | 7 +++++--
media/livestream/src/start_channel.php | 7 +++++--
media/livestream/src/stop_channel.php | 7 +++++--
media/livestream/src/update_channel.php | 8 ++++++--
media/livestream/src/update_input.php | 8 ++++++--
18 files changed, 96 insertions(+), 35 deletions(-)
diff --git a/media/livestream/composer.json b/media/livestream/composer.json
index 4cef8b74f6..6946109888 100644
--- a/media/livestream/composer.json
+++ b/media/livestream/composer.json
@@ -2,6 +2,6 @@
"name": "google/live-stream-sample",
"type": "project",
"require": {
- "google/cloud-video-live-stream": "^0.3.0"
+ "google/cloud-video-live-stream": "^0.5.0"
}
}
diff --git a/media/livestream/src/create_channel.php b/media/livestream/src/create_channel.php
index 9d25f3d197..3f548ed1a4 100644
--- a/media/livestream/src/create_channel.php
+++ b/media/livestream/src/create_channel.php
@@ -25,11 +25,12 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_create_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\AudioStream;
use Google\Cloud\Video\LiveStream\V1\Channel;
use Google\Cloud\Video\LiveStream\V1\ElementaryStream;
use Google\Cloud\Video\LiveStream\V1\InputAttachment;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\CreateChannelRequest;
use Google\Cloud\Video\LiveStream\V1\Manifest;
use Google\Cloud\Video\LiveStream\V1\MuxStream;
use Google\Cloud\Video\LiveStream\V1\SegmentSettings;
@@ -118,7 +119,11 @@ function create_channel(
]);
// Run the channel creation request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->createChannel($parent, $channel, $channelId);
+ $request = (new CreateChannelRequest())
+ ->setParent($parent)
+ ->setChannel($channel)
+ ->setChannelId($channelId);
+ $operationResponse = $livestreamClient->createChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/livestream/src/create_channel_event.php b/media/livestream/src/create_channel_event.php
index b5000efebc..197429982e 100644
--- a/media/livestream/src/create_channel_event.php
+++ b/media/livestream/src/create_channel_event.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_create_channel_event]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\Event;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\CreateEventRequest;
use Google\Protobuf\Duration;
/**
@@ -56,7 +57,11 @@ function create_channel_event(
->setExecuteNow(true);
// Run the channel event creation request.
- $response = $livestreamClient->createEvent($parent, $event, $eventId);
+ $request = (new CreateEventRequest())
+ ->setParent($parent)
+ ->setEvent($event)
+ ->setEventId($eventId);
+ $response = $livestreamClient->createEvent($request);
// Print results.
printf('Channel event: %s' . PHP_EOL, $response->getName());
}
diff --git a/media/livestream/src/create_channel_with_backup_input.php b/media/livestream/src/create_channel_with_backup_input.php
index 27c2dfb3cf..8fe000053b 100644
--- a/media/livestream/src/create_channel_with_backup_input.php
+++ b/media/livestream/src/create_channel_with_backup_input.php
@@ -25,11 +25,12 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_create_channel_with_backup_input]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\AudioStream;
use Google\Cloud\Video\LiveStream\V1\Channel;
use Google\Cloud\Video\LiveStream\V1\ElementaryStream;
use Google\Cloud\Video\LiveStream\V1\InputAttachment;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\CreateChannelRequest;
use Google\Cloud\Video\LiveStream\V1\Manifest;
use Google\Cloud\Video\LiveStream\V1\MuxStream;
use Google\Cloud\Video\LiveStream\V1\SegmentSettings;
@@ -128,7 +129,11 @@ function create_channel_with_backup_input(
]);
// Run the channel creation request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->createChannel($parent, $channel, $channelId);
+ $request = (new CreateChannelRequest())
+ ->setParent($parent)
+ ->setChannel($channel)
+ ->setChannelId($channelId);
+ $operationResponse = $livestreamClient->createChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/livestream/src/create_input.php b/media/livestream/src/create_input.php
index f41dc2bddc..77591a1da6 100644
--- a/media/livestream/src/create_input.php
+++ b/media/livestream/src/create_input.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_create_input]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\Input;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\CreateInputRequest;
/**
* Creates an input. You send an input video stream to this endpoint.
@@ -48,7 +49,11 @@ function create_input(
->setType(Input\Type::RTMP_PUSH);
// Run the input creation request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->createInput($parent, $input, $inputId);
+ $request = (new CreateInputRequest())
+ ->setParent($parent)
+ ->setInput($input)
+ ->setInputId($inputId);
+ $operationResponse = $livestreamClient->createInput($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
diff --git a/media/livestream/src/delete_channel.php b/media/livestream/src/delete_channel.php
index 61276021b4..69eea1d404 100644
--- a/media/livestream/src/delete_channel.php
+++ b/media/livestream/src/delete_channel.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_delete_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\DeleteChannelRequest;
/**
* Deletes a channel.
@@ -44,7 +45,9 @@ function delete_channel(
$formattedName = $livestreamClient->channelName($callingProjectId, $location, $channelId);
// Run the channel deletion request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->deleteChannel($formattedName);
+ $request = (new DeleteChannelRequest())
+ ->setName($formattedName);
+ $operationResponse = $livestreamClient->deleteChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print status
diff --git a/media/livestream/src/delete_channel_event.php b/media/livestream/src/delete_channel_event.php
index a433be8af5..9a5bccbdc2 100644
--- a/media/livestream/src/delete_channel_event.php
+++ b/media/livestream/src/delete_channel_event.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_delete_channel_event]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\DeleteEventRequest;
/**
* Deletes a channel event.
@@ -46,7 +47,9 @@ function delete_channel_event(
$formattedName = $livestreamClient->eventName($callingProjectId, $location, $channelId, $eventId);
// Run the channel event deletion request.
- $livestreamClient->deleteEvent($formattedName);
+ $request = (new DeleteEventRequest())
+ ->setName($formattedName);
+ $livestreamClient->deleteEvent($request);
printf('Deleted channel event %s' . PHP_EOL, $eventId);
}
// [END livestream_delete_channel_event]
diff --git a/media/livestream/src/delete_input.php b/media/livestream/src/delete_input.php
index dedfd32edd..995cfe0d9e 100644
--- a/media/livestream/src/delete_input.php
+++ b/media/livestream/src/delete_input.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_delete_input]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\DeleteInputRequest;
/**
* Deletes an input.
@@ -44,7 +45,9 @@ function delete_input(
$formattedName = $livestreamClient->inputName($callingProjectId, $location, $inputId);
// Run the input deletion request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->deleteInput($formattedName);
+ $request = (new DeleteInputRequest())
+ ->setName($formattedName);
+ $operationResponse = $livestreamClient->deleteInput($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print status
diff --git a/media/livestream/src/get_channel.php b/media/livestream/src/get_channel.php
index 1527d26e9f..ae726eaad3 100644
--- a/media/livestream/src/get_channel.php
+++ b/media/livestream/src/get_channel.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_get_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\GetChannelRequest;
/**
* Gets a channel.
@@ -44,7 +45,9 @@ function get_channel(
$formattedName = $livestreamClient->channelName($callingProjectId, $location, $channelId);
// Get the channel.
- $response = $livestreamClient->getChannel($formattedName);
+ $request = (new GetChannelRequest())
+ ->setName($formattedName);
+ $response = $livestreamClient->getChannel($request);
// Print results
printf('Channel: %s' . PHP_EOL, $response->getName());
}
diff --git a/media/livestream/src/get_channel_event.php b/media/livestream/src/get_channel_event.php
index 9489116fbd..78120a9f0d 100644
--- a/media/livestream/src/get_channel_event.php
+++ b/media/livestream/src/get_channel_event.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_get_channel_event]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\GetEventRequest;
/**
* Gets a channel event.
@@ -46,7 +47,9 @@ function get_channel_event(
$formattedName = $livestreamClient->eventName($callingProjectId, $location, $channelId, $eventId);
// Get the channel event.
- $response = $livestreamClient->getEvent($formattedName);
+ $request = (new GetEventRequest())
+ ->setName($formattedName);
+ $response = $livestreamClient->getEvent($request);
printf('Channel event: %s' . PHP_EOL, $response->getName());
}
// [END livestream_get_channel_event]
diff --git a/media/livestream/src/get_input.php b/media/livestream/src/get_input.php
index d70fd809ce..60bdcf246b 100644
--- a/media/livestream/src/get_input.php
+++ b/media/livestream/src/get_input.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_get_input]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\GetInputRequest;
/**
* Gets an input.
@@ -44,7 +45,9 @@ function get_input(
$formattedName = $livestreamClient->inputName($callingProjectId, $location, $inputId);
// Get the input.
- $response = $livestreamClient->getInput($formattedName);
+ $request = (new GetInputRequest())
+ ->setName($formattedName);
+ $response = $livestreamClient->getInput($request);
// Print results
printf('Input: %s' . PHP_EOL, $response->getName());
}
diff --git a/media/livestream/src/list_channel_events.php b/media/livestream/src/list_channel_events.php
index 38a8685e87..1326e1b3b1 100644
--- a/media/livestream/src/list_channel_events.php
+++ b/media/livestream/src/list_channel_events.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_list_channel_events]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\ListEventsRequest;
/**
* Lists the channel events for a given channel.
@@ -42,8 +43,10 @@ function list_channel_events(
// Instantiate a client.
$livestreamClient = new LivestreamServiceClient();
$parent = $livestreamClient->channelName($callingProjectId, $location, $channelId);
+ $request = (new ListEventsRequest())
+ ->setParent($parent);
- $response = $livestreamClient->listEvents($parent);
+ $response = $livestreamClient->listEvents($request);
// Print the channel list.
$events = $response->iterateAllElements();
print('Channel events:' . PHP_EOL);
diff --git a/media/livestream/src/list_channels.php b/media/livestream/src/list_channels.php
index fe44881d18..d3d459fb90 100644
--- a/media/livestream/src/list_channels.php
+++ b/media/livestream/src/list_channels.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_list_channels]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\ListChannelsRequest;
/**
* Lists the channels for a given location.
@@ -40,8 +41,10 @@ function list_channels(
// Instantiate a client.
$livestreamClient = new LivestreamServiceClient();
$parent = $livestreamClient->locationName($callingProjectId, $location);
+ $request = (new ListChannelsRequest())
+ ->setParent($parent);
- $response = $livestreamClient->listChannels($parent);
+ $response = $livestreamClient->listChannels($request);
// Print the channel list.
$channels = $response->iterateAllElements();
print('Channels:' . PHP_EOL);
diff --git a/media/livestream/src/list_inputs.php b/media/livestream/src/list_inputs.php
index 8d6246cff7..a24146894a 100644
--- a/media/livestream/src/list_inputs.php
+++ b/media/livestream/src/list_inputs.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_list_inputs]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\ListInputsRequest;
/**
* Lists the inputs for a given location.
@@ -40,8 +41,10 @@ function list_inputs(
// Instantiate a client.
$livestreamClient = new LivestreamServiceClient();
$parent = $livestreamClient->locationName($callingProjectId, $location);
+ $request = (new ListInputsRequest())
+ ->setParent($parent);
- $response = $livestreamClient->listInputs($parent);
+ $response = $livestreamClient->listInputs($request);
// Print the input list.
$inputs = $response->iterateAllElements();
print('Inputs:' . PHP_EOL);
diff --git a/media/livestream/src/start_channel.php b/media/livestream/src/start_channel.php
index c50d437806..1a6b4ab726 100644
--- a/media/livestream/src/start_channel.php
+++ b/media/livestream/src/start_channel.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_start_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\StartChannelRequest;
/**
* Starts a channel.
@@ -44,7 +45,9 @@ function start_channel(
$formattedName = $livestreamClient->channelName($callingProjectId, $location, $channelId);
// Run the channel start request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->startChannel($formattedName);
+ $request = (new StartChannelRequest())
+ ->setName($formattedName);
+ $operationResponse = $livestreamClient->startChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print results
diff --git a/media/livestream/src/stop_channel.php b/media/livestream/src/stop_channel.php
index 172264d325..8c8d65fd7f 100644
--- a/media/livestream/src/stop_channel.php
+++ b/media/livestream/src/stop_channel.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_stop_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\StopChannelRequest;
/**
* Stops a channel.
@@ -44,7 +45,9 @@ function stop_channel(
$formattedName = $livestreamClient->channelName($callingProjectId, $location, $channelId);
// Run the channel stop request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->stopChannel($formattedName);
+ $request = (new StopChannelRequest())
+ ->setName($formattedName);
+ $operationResponse = $livestreamClient->stopChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// Print results
diff --git a/media/livestream/src/update_channel.php b/media/livestream/src/update_channel.php
index 7548ac1334..05c778f534 100644
--- a/media/livestream/src/update_channel.php
+++ b/media/livestream/src/update_channel.php
@@ -25,9 +25,10 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_update_channel]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\Channel;
use Google\Cloud\Video\LiveStream\V1\InputAttachment;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
+use Google\Cloud\Video\LiveStream\V1\UpdateChannelRequest;
use Google\Protobuf\FieldMask;
/**
@@ -62,7 +63,10 @@ function update_channel(
]);
// Run the channel update request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->updateChannel($channel, ['updateMask' => $updateMask]);
+ $request = (new UpdateChannelRequest())
+ ->setChannel($channel)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $livestreamClient->updateChannel($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
diff --git a/media/livestream/src/update_input.php b/media/livestream/src/update_input.php
index 0815372f28..22f85720a6 100644
--- a/media/livestream/src/update_input.php
+++ b/media/livestream/src/update_input.php
@@ -25,9 +25,10 @@
namespace Google\Cloud\Samples\Media\LiveStream;
// [START livestream_update_input]
-use Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\Input;
+use Google\Cloud\Video\LiveStream\V1\Client\LivestreamServiceClient;
use Google\Cloud\Video\LiveStream\V1\PreprocessingConfig;
+use Google\Cloud\Video\LiveStream\V1\UpdateInputRequest;
use Google\Protobuf\FieldMask;
/**
@@ -60,7 +61,10 @@ function update_input(
]);
// Run the input update request. The response is a long-running operation ID.
- $operationResponse = $livestreamClient->updateInput($input, ['updateMask' => $updateMask]);
+ $request = (new UpdateInputRequest())
+ ->setInput($input)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $livestreamClient->updateInput($request);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
From cab377b8b9504f885adfa80c128f66ae1bcb7235 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:08:09 -0600
Subject: [PATCH 051/285] chore: upgrade mediatranscoder samples to new GAPIC
(#1869)
---
media/transcoder/composer.json | 2 +-
media/transcoder/src/create_job_from_ad_hoc.php | 8 ++++++--
media/transcoder/src/create_job_from_preset.php | 8 ++++++--
media/transcoder/src/create_job_from_template.php | 8 ++++++--
media/transcoder/src/create_job_template.php | 9 +++++++--
.../transcoder/src/create_job_with_animated_overlay.php | 8 ++++++--
.../src/create_job_with_concatenated_inputs.php | 8 ++++++--
.../src/create_job_with_periodic_images_spritesheet.php | 8 ++++++--
.../create_job_with_set_number_images_spritesheet.php | 8 ++++++--
media/transcoder/src/create_job_with_static_overlay.php | 8 ++++++--
media/transcoder/src/delete_job.php | 7 +++++--
media/transcoder/src/delete_job_template.php | 7 +++++--
media/transcoder/src/get_job.php | 7 +++++--
media/transcoder/src/get_job_state.php | 7 +++++--
media/transcoder/src/get_job_template.php | 7 +++++--
media/transcoder/src/list_job_templates.php | 7 +++++--
media/transcoder/src/list_jobs.php | 7 +++++--
17 files changed, 91 insertions(+), 33 deletions(-)
diff --git a/media/transcoder/composer.json b/media/transcoder/composer.json
index 969488d191..2183bb528e 100644
--- a/media/transcoder/composer.json
+++ b/media/transcoder/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/cloud-video-transcoder": "^0.6.0",
+ "google/cloud-video-transcoder": "^0.8.2",
"google/cloud-storage": "^1.9",
"ext-bcmath": "*"
}
diff --git a/media/transcoder/src/create_job_from_ad_hoc.php b/media/transcoder/src/create_job_from_ad_hoc.php
index 294401a755..ca3ea2b7fc 100644
--- a/media/transcoder/src/create_job_from_ad_hoc.php
+++ b/media/transcoder/src/create_job_from_ad_hoc.php
@@ -26,11 +26,12 @@
# [START transcoder_create_job_from_ad_hoc]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
/**
@@ -95,8 +96,11 @@ function create_job_from_ad_hoc($projectId, $location, $inputUri, $outputUri)
->setInputUri($inputUri)
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_from_preset.php b/media/transcoder/src/create_job_from_preset.php
index ef9a8b2216..aa9d3c795f 100644
--- a/media/transcoder/src/create_job_from_preset.php
+++ b/media/transcoder/src/create_job_from_preset.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_create_job_from_preset]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\Job;
/**
@@ -47,8 +48,11 @@ function create_job_from_preset($projectId, $location, $inputUri, $outputUri, $p
$job->setInputUri($inputUri);
$job->setOutputUri($outputUri);
$job->setTemplateId($preset);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_from_template.php b/media/transcoder/src/create_job_from_template.php
index 811866daa4..76c7399a3f 100644
--- a/media/transcoder/src/create_job_from_template.php
+++ b/media/transcoder/src/create_job_from_template.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_create_job_from_template]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\Job;
/**
@@ -47,8 +48,11 @@ function create_job_from_template($projectId, $location, $inputUri, $outputUri,
$job->setInputUri($inputUri);
$job->setOutputUri($outputUri);
$job->setTemplateId($templateId);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_template.php b/media/transcoder/src/create_job_template.php
index debbe4184a..f2053aefb3 100644
--- a/media/transcoder/src/create_job_template.php
+++ b/media/transcoder/src/create_job_template.php
@@ -26,11 +26,12 @@
# [START transcoder_create_job_template]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobTemplateRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\JobTemplate;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
/**
@@ -89,8 +90,12 @@ function create_job_template($projectId, $location, $templateId)
->setElementaryStreams(['video-stream1', 'audio-stream0'])
])
);
+ $request = (new CreateJobTemplateRequest())
+ ->setParent($formattedParent)
+ ->setJobTemplate($jobTemplate)
+ ->setJobTemplateId($templateId);
- $response = $transcoderServiceClient->createJobTemplate($formattedParent, $jobTemplate, $templateId);
+ $response = $transcoderServiceClient->createJobTemplate($request);
// Print job template name.
printf('Job template: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_with_animated_overlay.php b/media/transcoder/src/create_job_with_animated_overlay.php
index 493a5dd570..403b192f5f 100644
--- a/media/transcoder/src/create_job_with_animated_overlay.php
+++ b/media/transcoder/src/create_job_with_animated_overlay.php
@@ -26,12 +26,13 @@
# [START transcoder_create_job_with_animated_overlay]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
use Google\Cloud\Video\Transcoder\V1\Overlay;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
use Google\Protobuf\Duration;
@@ -115,8 +116,11 @@ function create_job_with_animated_overlay($projectId, $location, $inputUri, $ove
->setInputUri($inputUri)
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_with_concatenated_inputs.php b/media/transcoder/src/create_job_with_concatenated_inputs.php
index ab9d5a553d..9365344730 100644
--- a/media/transcoder/src/create_job_with_concatenated_inputs.php
+++ b/media/transcoder/src/create_job_with_concatenated_inputs.php
@@ -26,13 +26,14 @@
# [START transcoder_create_job_with_concatenated_inputs]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\EditAtom;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Input;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
use Google\Protobuf\Duration;
@@ -113,8 +114,11 @@ function create_job_with_concatenated_inputs($projectId, $location, $input1Uri,
$job = (new Job())
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_with_periodic_images_spritesheet.php b/media/transcoder/src/create_job_with_periodic_images_spritesheet.php
index 9baf2d6088..b3f6ac55ca 100644
--- a/media/transcoder/src/create_job_with_periodic_images_spritesheet.php
+++ b/media/transcoder/src/create_job_with_periodic_images_spritesheet.php
@@ -26,12 +26,13 @@
# [START transcoder_create_job_with_periodic_images_spritesheet]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
use Google\Cloud\Video\Transcoder\V1\SpriteSheet;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
use Google\Protobuf\Duration;
@@ -96,8 +97,11 @@ function create_job_with_periodic_images_spritesheet($projectId, $location, $inp
->setInputUri($inputUri)
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_with_set_number_images_spritesheet.php b/media/transcoder/src/create_job_with_set_number_images_spritesheet.php
index 5051e7b4b1..1e4381669a 100644
--- a/media/transcoder/src/create_job_with_set_number_images_spritesheet.php
+++ b/media/transcoder/src/create_job_with_set_number_images_spritesheet.php
@@ -26,12 +26,13 @@
# [START transcoder_create_job_with_set_number_images_spritesheet]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
use Google\Cloud\Video\Transcoder\V1\SpriteSheet;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
/**
@@ -96,8 +97,11 @@ function create_job_with_set_number_images_spritesheet($projectId, $location, $i
->setInputUri($inputUri)
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/create_job_with_static_overlay.php b/media/transcoder/src/create_job_with_static_overlay.php
index 0897bd1564..5a055f4bfe 100644
--- a/media/transcoder/src/create_job_with_static_overlay.php
+++ b/media/transcoder/src/create_job_with_static_overlay.php
@@ -26,12 +26,13 @@
# [START transcoder_create_job_with_static_overlay]
use Google\Cloud\Video\Transcoder\V1\AudioStream;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\ElementaryStream;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\JobConfig;
use Google\Cloud\Video\Transcoder\V1\MuxStream;
use Google\Cloud\Video\Transcoder\V1\Overlay;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\VideoStream;
use Google\Protobuf\Duration;
@@ -117,8 +118,11 @@ function create_job_with_static_overlay($projectId, $location, $inputUri, $overl
->setInputUri($inputUri)
->setOutputUri($outputUri)
->setConfig($jobConfig);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
- $response = $transcoderServiceClient->createJob($formattedParent, $job);
+ $response = $transcoderServiceClient->createJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $response->getName());
diff --git a/media/transcoder/src/delete_job.php b/media/transcoder/src/delete_job.php
index 5be6cf30a0..f48cf1450e 100644
--- a/media/transcoder/src/delete_job.php
+++ b/media/transcoder/src/delete_job.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_delete_job]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\DeleteJobRequest;
/**
* Deletes a Transcoder job.
@@ -40,7 +41,9 @@ function delete_job($projectId, $location, $jobId)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedName = $transcoderServiceClient->jobName($projectId, $location, $jobId);
- $transcoderServiceClient->deleteJob($formattedName);
+ $request = (new DeleteJobRequest())
+ ->setName($formattedName);
+ $transcoderServiceClient->deleteJob($request);
print('Deleted job' . PHP_EOL);
}
diff --git a/media/transcoder/src/delete_job_template.php b/media/transcoder/src/delete_job_template.php
index 9071b84bb6..a0eb2b177c 100644
--- a/media/transcoder/src/delete_job_template.php
+++ b/media/transcoder/src/delete_job_template.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_delete_job_template]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\DeleteJobTemplateRequest;
/**
* Deletes a Transcoder job template.
@@ -40,7 +41,9 @@ function delete_job_template($projectId, $location, $templateId)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedName = $transcoderServiceClient->jobTemplateName($projectId, $location, $templateId);
- $transcoderServiceClient->deleteJobTemplate($formattedName);
+ $request = (new DeleteJobTemplateRequest())
+ ->setName($formattedName);
+ $transcoderServiceClient->deleteJobTemplate($request);
print('Deleted job template' . PHP_EOL);
}
diff --git a/media/transcoder/src/get_job.php b/media/transcoder/src/get_job.php
index 5b26ed530c..7b2865da04 100644
--- a/media/transcoder/src/get_job.php
+++ b/media/transcoder/src/get_job.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_get_job]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\GetJobRequest;
/**
* Gets a Transcoder job.
@@ -40,7 +41,9 @@ function get_job($projectId, $location, $jobId)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedName = $transcoderServiceClient->jobName($projectId, $location, $jobId);
- $job = $transcoderServiceClient->getJob($formattedName);
+ $request = (new GetJobRequest())
+ ->setName($formattedName);
+ $job = $transcoderServiceClient->getJob($request);
// Print job name.
printf('Job: %s' . PHP_EOL, $job->getName());
diff --git a/media/transcoder/src/get_job_state.php b/media/transcoder/src/get_job_state.php
index 2f4331bad6..c135ff32c0 100644
--- a/media/transcoder/src/get_job_state.php
+++ b/media/transcoder/src/get_job_state.php
@@ -25,8 +25,9 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_get_job_state]
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\GetJobRequest;
use Google\Cloud\Video\Transcoder\V1\Job;
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
/**
* Gets a Transcoder job's state.
@@ -41,7 +42,9 @@ function get_job_state($projectId, $location, $jobId)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedName = $transcoderServiceClient->jobName($projectId, $location, $jobId);
- $job = $transcoderServiceClient->getJob($formattedName);
+ $request = (new GetJobRequest())
+ ->setName($formattedName);
+ $job = $transcoderServiceClient->getJob($request);
// Print job state.
printf('Job state: %s' . PHP_EOL, Job\ProcessingState::name($job->getState()));
diff --git a/media/transcoder/src/get_job_template.php b/media/transcoder/src/get_job_template.php
index e03e8238cf..a37f7aa92e 100644
--- a/media/transcoder/src/get_job_template.php
+++ b/media/transcoder/src/get_job_template.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_get_job_template]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\GetJobTemplateRequest;
/**
* Gets a Transcoder job template.
@@ -40,7 +41,9 @@ function get_job_template($projectId, $location, $templateId)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedName = $transcoderServiceClient->jobTemplateName($projectId, $location, $templateId);
- $template = $transcoderServiceClient->getJobTemplate($formattedName);
+ $request = (new GetJobTemplateRequest())
+ ->setName($formattedName);
+ $template = $transcoderServiceClient->getJobTemplate($request);
// Print job template name.
printf('Job template: %s' . PHP_EOL, $template->getName());
diff --git a/media/transcoder/src/list_job_templates.php b/media/transcoder/src/list_job_templates.php
index 18e0ae7230..942c034509 100644
--- a/media/transcoder/src/list_job_templates.php
+++ b/media/transcoder/src/list_job_templates.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_list_job_templates]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\ListJobTemplatesRequest;
/**
* Lists all Transcoder job templates in a location.
@@ -39,7 +40,9 @@ function list_job_templates($projectId, $location)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedParent = $transcoderServiceClient->locationName($projectId, $location);
- $response = $transcoderServiceClient->listJobTemplates($formattedParent);
+ $request = (new ListJobTemplatesRequest())
+ ->setParent($formattedParent);
+ $response = $transcoderServiceClient->listJobTemplates($request);
// Print job template list.
$jobTemplates = $response->iterateAllElements();
diff --git a/media/transcoder/src/list_jobs.php b/media/transcoder/src/list_jobs.php
index b890568400..5b396dd973 100644
--- a/media/transcoder/src/list_jobs.php
+++ b/media/transcoder/src/list_jobs.php
@@ -25,7 +25,8 @@
namespace Google\Cloud\Samples\Media\Transcoder;
# [START transcoder_list_jobs]
-use Google\Cloud\Video\Transcoder\V1\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
+use Google\Cloud\Video\Transcoder\V1\ListJobsRequest;
/**
* Lists all Transcoder jobs in a location.
@@ -39,7 +40,9 @@ function list_jobs($projectId, $location)
$transcoderServiceClient = new TranscoderServiceClient();
$formattedParent = $transcoderServiceClient->locationName($projectId, $location);
- $response = $transcoderServiceClient->listJobs($formattedParent);
+ $request = (new ListJobsRequest())
+ ->setParent($formattedParent);
+ $response = $transcoderServiceClient->listJobs($request);
// Print job list.
$jobs = $response->iterateAllElements();
From 9b3b2e3073025c22a47fa67a0b26e45a29079df7 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 20 Jul 2023 10:09:35 -0600
Subject: [PATCH 052/285] chore: upgrade language samples to new surface
(#1868)
---
language/composer.json | 2 +-
language/src/analyze_all.php | 8 ++++++--
language/src/analyze_all_from_file.php | 8 ++++++--
language/src/analyze_entities.php | 7 +++++--
language/src/analyze_entities_from_file.php | 7 +++++--
language/src/analyze_entity_sentiment.php | 7 +++++--
language/src/analyze_entity_sentiment_from_file.php | 7 +++++--
language/src/analyze_sentiment.php | 7 +++++--
language/src/analyze_sentiment_from_file.php | 7 +++++--
language/src/analyze_syntax.php | 7 +++++--
language/src/analyze_syntax_from_file.php | 7 +++++--
language/src/classify_text.php | 7 +++++--
language/src/classify_text_from_file.php | 7 +++++--
13 files changed, 63 insertions(+), 25 deletions(-)
diff --git a/language/composer.json b/language/composer.json
index 896937c4fd..7b37a23096 100644
--- a/language/composer.json
+++ b/language/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/cloud-language": "^0.28.0",
+ "google/cloud-language": "^0.30.2",
"google/cloud-storage": "^1.20.1"
}
}
diff --git a/language/src/analyze_all.php b/language/src/analyze_all.php
index 2b3949a6c3..cb3b938440 100644
--- a/language/src/analyze_all.php
+++ b/language/src/analyze_all.php
@@ -24,10 +24,11 @@
namespace Google\Cloud\Samples\Language;
# [START analyze_all]
+use Google\Cloud\Language\V1\AnnotateTextRequest;
use Google\Cloud\Language\V1\AnnotateTextRequest\Features;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
use Google\Cloud\Language\V1\EntityMention\Type as MentionType;
use Google\Cloud\Language\V1\PartOfSpeech\Tag;
@@ -52,7 +53,10 @@ function analyze_all(string $text): void
->setExtractDocumentSentiment(true);
// Collect annotations
- $response = $languageServiceClient->annotateText($document, $features);
+ $request = (new AnnotateTextRequest())
+ ->setDocument($document)
+ ->setFeatures($features);
+ $response = $languageServiceClient->annotateText($request);
// Process Entities
$entities = $response->getEntities();
foreach ($entities as $entity) {
diff --git a/language/src/analyze_all_from_file.php b/language/src/analyze_all_from_file.php
index 3700f436db..b912f530b4 100644
--- a/language/src/analyze_all_from_file.php
+++ b/language/src/analyze_all_from_file.php
@@ -24,10 +24,11 @@
namespace Google\Cloud\Samples\Language;
# [START analyze_all_from_file]
+use Google\Cloud\Language\V1\AnnotateTextRequest;
use Google\Cloud\Language\V1\AnnotateTextRequest\Features;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
use Google\Cloud\Language\V1\EntityMention\Type as MentionType;
use Google\Cloud\Language\V1\PartOfSpeech\Tag;
@@ -52,7 +53,10 @@ function analyze_all_from_file(string $uri): void
->setExtractDocumentSentiment(true);
// Collect annotations
- $response = $languageServiceClient->annotateText($document, $features);
+ $request = (new AnnotateTextRequest())
+ ->setDocument($document)
+ ->setFeatures($features);
+ $response = $languageServiceClient->annotateText($request);
// Process Entities
$entities = $response->getEntities();
diff --git a/language/src/analyze_entities.php b/language/src/analyze_entities.php
index aae01e4a20..56fd20a229 100644
--- a/language/src/analyze_entities.php
+++ b/language/src/analyze_entities.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_entities_text]
+use Google\Cloud\Language\V1\AnalyzeEntitiesRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
/**
@@ -43,7 +44,9 @@ function analyze_entities(string $text): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntities function
- $response = $languageServiceClient->analyzeEntities($document, []);
+ $request = (new AnalyzeEntitiesRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeEntities($request);
$entities = $response->getEntities();
// Print out information about each entity
foreach ($entities as $entity) {
diff --git a/language/src/analyze_entities_from_file.php b/language/src/analyze_entities_from_file.php
index ad46f17d6b..8007a8cbc4 100644
--- a/language/src/analyze_entities_from_file.php
+++ b/language/src/analyze_entities_from_file.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_entities_gcs]
+use Google\Cloud\Language\V1\AnalyzeEntitiesRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
/**
@@ -43,7 +44,9 @@ function analyze_entities_from_file(string $uri): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntities function
- $response = $languageServiceClient->analyzeEntities($document, []);
+ $request = (new AnalyzeEntitiesRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeEntities($request);
$entities = $response->getEntities();
// Print out information about each entity
foreach ($entities as $entity) {
diff --git a/language/src/analyze_entity_sentiment.php b/language/src/analyze_entity_sentiment.php
index 4b786b15ed..7800f39938 100644
--- a/language/src/analyze_entity_sentiment.php
+++ b/language/src/analyze_entity_sentiment.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_entity_sentiment_text]
+use Google\Cloud\Language\V1\AnalyzeEntitySentimentRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
/**
@@ -42,7 +43,9 @@ function analyze_entity_sentiment(string $text): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntitySentiment function
- $response = $languageServiceClient->analyzeEntitySentiment($document);
+ $request = (new AnalyzeEntitySentimentRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeEntitySentiment($request);
$entities = $response->getEntities();
// Print out information about each entity
foreach ($entities as $entity) {
diff --git a/language/src/analyze_entity_sentiment_from_file.php b/language/src/analyze_entity_sentiment_from_file.php
index 686b953930..78f75f9249 100644
--- a/language/src/analyze_entity_sentiment_from_file.php
+++ b/language/src/analyze_entity_sentiment_from_file.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_entity_sentiment_gcs]
+use Google\Cloud\Language\V1\AnalyzeEntitySentimentRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\Entity\Type as EntityType;
/**
@@ -43,7 +44,9 @@ function analyze_entity_sentiment_from_file(string $uri): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntitySentiment function
- $response = $languageServiceClient->analyzeEntitySentiment($document);
+ $request = (new AnalyzeEntitySentimentRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeEntitySentiment($request);
$entities = $response->getEntities();
// Print out information about each entity
foreach ($entities as $entity) {
diff --git a/language/src/analyze_sentiment.php b/language/src/analyze_sentiment.php
index e56ede362d..8c9fae6794 100644
--- a/language/src/analyze_sentiment.php
+++ b/language/src/analyze_sentiment.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_sentiment_text]
+use Google\Cloud\Language\V1\AnalyzeSentimentRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
/**
* @param string $text The text to analyze
@@ -41,7 +42,9 @@ function analyze_sentiment(string $text): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeSentiment function
- $response = $languageServiceClient->analyzeSentiment($document);
+ $request = (new AnalyzeSentimentRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeSentiment($request);
$document_sentiment = $response->getDocumentSentiment();
// Print document information
printf('Document Sentiment:' . PHP_EOL);
diff --git a/language/src/analyze_sentiment_from_file.php b/language/src/analyze_sentiment_from_file.php
index 6e1a166316..8f07a731d3 100644
--- a/language/src/analyze_sentiment_from_file.php
+++ b/language/src/analyze_sentiment_from_file.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_sentiment_gcs]
+use Google\Cloud\Language\V1\AnalyzeSentimentRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
/**
* @param string $uri The cloud storage object to analyze (gs://your-bucket-name/your-object-name)
@@ -41,7 +42,9 @@ function analyze_sentiment_from_file(string $uri): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeSentiment function
- $response = $languageServiceClient->analyzeSentiment($document);
+ $request = (new AnalyzeSentimentRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeSentiment($request);
$document_sentiment = $response->getDocumentSentiment();
// Print document information
printf('Document Sentiment:' . PHP_EOL);
diff --git a/language/src/analyze_syntax.php b/language/src/analyze_syntax.php
index dd47188bd8..54a0afb1a7 100644
--- a/language/src/analyze_syntax.php
+++ b/language/src/analyze_syntax.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_syntax_text]
+use Google\Cloud\Language\V1\AnalyzeSyntaxRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\PartOfSpeech\Tag;
/**
@@ -43,7 +44,9 @@ function analyze_syntax(string $text): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntities function
- $response = $languageServiceClient->analyzeSyntax($document, []);
+ $request = (new AnalyzeSyntaxRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeSyntax($request);
$tokens = $response->getTokens();
// Print out information about each entity
foreach ($tokens as $token) {
diff --git a/language/src/analyze_syntax_from_file.php b/language/src/analyze_syntax_from_file.php
index 76f33bd572..4b8412a39e 100644
--- a/language/src/analyze_syntax_from_file.php
+++ b/language/src/analyze_syntax_from_file.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_syntax_gcs]
+use Google\Cloud\Language\V1\AnalyzeSyntaxRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
use Google\Cloud\Language\V1\PartOfSpeech\Tag;
/**
@@ -43,7 +44,9 @@ function analyze_syntax_from_file(string $uri): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeEntities function
- $response = $languageServiceClient->analyzeSyntax($document, []);
+ $request = (new AnalyzeSyntaxRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->analyzeSyntax($request);
$tokens = $response->getTokens();
// Print out information about each entity
foreach ($tokens as $token) {
diff --git a/language/src/classify_text.php b/language/src/classify_text.php
index aceeeb9b64..16294beb63 100644
--- a/language/src/classify_text.php
+++ b/language/src/classify_text.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_classify_text]
+use Google\Cloud\Language\V1\ClassifyTextRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
/**
* @param string $text The text to analyze
@@ -46,7 +47,9 @@ function classify_text(string $text): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeSentiment function
- $response = $languageServiceClient->classifyText($document);
+ $request = (new ClassifyTextRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->classifyText($request);
$categories = $response->getCategories();
// Print document information
foreach ($categories as $category) {
diff --git a/language/src/classify_text_from_file.php b/language/src/classify_text_from_file.php
index b73027eb89..c482fd0503 100644
--- a/language/src/classify_text_from_file.php
+++ b/language/src/classify_text_from_file.php
@@ -24,9 +24,10 @@
namespace Google\Cloud\Samples\Language;
# [START language_classify_gcs]
+use Google\Cloud\Language\V1\ClassifyTextRequest;
+use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\Document\Type;
-use Google\Cloud\Language\V1\LanguageServiceClient;
/**
* @param string $uri The cloud storage object to analyze (gs://your-bucket-name/your-object-name)
@@ -41,7 +42,9 @@ function classify_text_from_file(string $uri): void
->setType(Type::PLAIN_TEXT);
// Call the analyzeSentiment function
- $response = $languageServiceClient->classifyText($document);
+ $request = (new ClassifyTextRequest())
+ ->setDocument($document);
+ $response = $languageServiceClient->classifyText($request);
$categories = $response->getCategories();
// Print document information
foreach ($categories as $category) {
From 86248cfbecc919e356b7ac54072b345af518d753 Mon Sep 17 00:00:00 2001
From: Ajumal
Date: Tue, 25 Jul 2023 14:33:40 +0530
Subject: [PATCH 053/285] feat(Spanner): Add foreign key delete cascade samples
(#1828)
---
..._table_with_foreign_key_delete_cascade.php | 70 +++++++++++++++++
..._table_with_foreign_key_delete_cascade.php | 77 +++++++++++++++++++
..._foreign_key_constraint_delete_cascade.php | 67 ++++++++++++++++
spanner/test/spannerTest.php | 39 ++++++++++
4 files changed, 253 insertions(+)
create mode 100644 spanner/src/alter_table_with_foreign_key_delete_cascade.php
create mode 100644 spanner/src/create_table_with_foreign_key_delete_cascade.php
create mode 100644 spanner/src/drop_foreign_key_constraint_delete_cascade.php
diff --git a/spanner/src/alter_table_with_foreign_key_delete_cascade.php b/spanner/src/alter_table_with_foreign_key_delete_cascade.php
new file mode 100644
index 0000000000..17b6e3e667
--- /dev/null
+++ b/spanner/src/alter_table_with_foreign_key_delete_cascade.php
@@ -0,0 +1,70 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+
+ $operation = $database->updateDdl(
+ 'ALTER TABLE ShoppingCarts
+ ADD CONSTRAINT FKShoppingCartsCustomerName
+ FOREIGN KEY (CustomerName)
+ REFERENCES Customers(CustomerName)
+ ON DELETE CASCADE'
+ );
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(sprintf(
+ 'Altered ShoppingCarts table with FKShoppingCartsCustomerName ' .
+ 'foreign key constraint on database %s on instance %s %s',
+ $databaseId,
+ $instanceId,
+ PHP_EOL
+ ));
+}
+// [END spanner_alter_table_with_foreign_key_delete_cascade]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/create_table_with_foreign_key_delete_cascade.php b/spanner/src/create_table_with_foreign_key_delete_cascade.php
new file mode 100644
index 0000000000..5117cc722e
--- /dev/null
+++ b/spanner/src/create_table_with_foreign_key_delete_cascade.php
@@ -0,0 +1,77 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+
+ $operation = $database->updateDdlBatch([
+ 'CREATE TABLE Customers (
+ CustomerId INT64 NOT NULL,
+ CustomerName STRING(62) NOT NULL,
+ ) PRIMARY KEY (CustomerId)',
+ 'CREATE TABLE ShoppingCarts (
+ CartId INT64 NOT NULL,
+ CustomerId INT64 NOT NULL,
+ CustomerName STRING(62) NOT NULL,
+ CONSTRAINT FKShoppingCartsCustomerId FOREIGN KEY (CustomerId)
+ REFERENCES Customers (CustomerId) ON DELETE CASCADE
+ ) PRIMARY KEY (CartId)'
+ ]);
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(sprintf(
+ 'Created Customers and ShoppingCarts table with ' .
+ 'FKShoppingCartsCustomerId foreign key constraint ' .
+ 'on database %s on instance %s %s',
+ $databaseId,
+ $instanceId,
+ PHP_EOL
+ ));
+}
+// [END spanner_create_table_with_foreign_key_delete_cascade]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/drop_foreign_key_constraint_delete_cascade.php b/spanner/src/drop_foreign_key_constraint_delete_cascade.php
new file mode 100644
index 0000000000..e77f97bb1d
--- /dev/null
+++ b/spanner/src/drop_foreign_key_constraint_delete_cascade.php
@@ -0,0 +1,67 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+
+ $operation = $database->updateDdl(
+ 'ALTER TABLE ShoppingCarts
+ DROP CONSTRAINT FKShoppingCartsCustomerName'
+ );
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(sprintf(
+ 'Altered ShoppingCarts table to drop FKShoppingCartsCustomerName ' .
+ 'foreign key constraint on database %s on instance %s %s',
+ $databaseId,
+ $instanceId,
+ PHP_EOL
+ ));
+}
+// [END spanner_drop_foreign_key_constraint_delete_cascade]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php
index d1eb54a135..52b5aa8a9a 100644
--- a/spanner/test/spannerTest.php
+++ b/spanner/test/spannerTest.php
@@ -1189,4 +1189,43 @@ public static function tearDownAfterClass(): void
self::deleteServiceAccount(self::$serviceAccountEmail);
}
}
+
+ public function testCreateTableForeignKeyDeleteCascade()
+ {
+ $output = $this->runFunctionSnippet('create_table_with_foreign_key_delete_cascade');
+ $this->assertStringContainsString('Waiting for operation to complete...', $output);
+ $this->assertStringContainsString(
+ 'Created Customers and ShoppingCarts table with FKShoppingCartsCustomerId ' .
+ 'foreign key constraint on database',
+ $output
+ );
+ }
+
+ /**
+ * @depends testCreateTableForeignKeyDeleteCascade
+ */
+ public function testAlterTableDropForeignKeyDeleteCascade()
+ {
+ $output = $this->runFunctionSnippet('drop_foreign_key_constraint_delete_cascade');
+ $this->assertStringContainsString('Waiting for operation to complete...', $output);
+ $this->assertStringContainsString(
+ 'Altered ShoppingCarts table to drop FKShoppingCartsCustomerName ' .
+ 'foreign key constraint on database',
+ $output
+ );
+ }
+
+ /**
+ * @depends testAlterTableDropForeignKeyDeleteCascade
+ */
+ public function testAlterTableAddForeignKeyDeleteCascade()
+ {
+ $output = $this->runFunctionSnippet('alter_table_with_foreign_key_delete_cascade');
+ $this->assertStringContainsString('Waiting for operation to complete...', $output);
+ $this->assertStringContainsString(
+ 'Altered ShoppingCarts table with FKShoppingCartsCustomerName ' .
+ 'foreign key constraint on database',
+ $output
+ );
+ }
}
From 30334b204f6f3b6d5940e46ac6da487593155140 Mon Sep 17 00:00:00 2001
From: Vishwaraj Anand
Date: Thu, 27 Jul 2023 13:45:44 +0530
Subject: [PATCH 054/285] chore: add project id in kms key commands (#1893)
---
.kokoro/secrets.sh.enc | Bin 9051 -> 9119 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
diff --git a/.kokoro/secrets.sh.enc b/.kokoro/secrets.sh.enc
index 8a77849de1a1e69b005ad1816701213aab4dc9cf..eaf26147ae4914ad7acfdc3c9370e43d9592336a 100644
GIT binary patch
literal 9119
zcmV;QBVgPLBmfTBrg}MqvMUC+U59enRFZg3pmmcxg)nQ88jnf=`Zup34iff80LMxY
zs@lY{kQ1fZve6wQ^oOu;6&hG8CC!>hdr_1d1$++3AvM3I&@?LWl}P~|G>6e6%RxFT
z-C31YfoyCS94pos!*3Tt$?$u=Vg1-aw@%O;AcOg0{a#DgYo-+d)_3DH0C3;B13P=6
zi@(JI6zZXaE%?)!Shwn%D7c9^F?v}K&GtP(YTDn)WgdZ|n89ooZ*J@Td6xTrLa7kvIg
zKoQ%WuW?7Ub5PH|yNJ7BELXfE>A{L)T8ibruA9Ua(8lqbk4cmu$LwkT8`?t~LJ0=z
z=vBwm;D}Q`jeXMRm_P2-65M@G=Kv#fU47}u*CdM`eDma*YyfQi19G#YV;(YLC%Q3p
ziHx(e6jN&xDOz^c!;jIKTX550u@Fe3$^EOOfa9s8TP*qDCa44N?g1cf3N*@2pnM7E
zYfkXutOa*R>4ObCC568>f-Gd%<*^kF)qLaRD4N;OaXkK&1d2L*y#GnCks@zGGJxKbmH*{nXi0Px6K*q#
zN9ED~2VP(MK*BrZ>-C~WWPBP5g9(3fRzyxjt4UQ}1tn<9E^4&2%SLSVg@)~C$uT<7Ld97bvEs@-P?L*GnR7B%91tB78@6+Y
zj)4!~!5m12#Udp(b{{>FOB^)BC3`)@+^cTD>%t(&Zz_u?3kL`}jVA06@T%dK?n>D`
zn}GOmr}AnQeYwbkonGcb>I!b3AU?WuII5hoL;GNY8aE>()}_VM?30qRA6G=EOTb0?
zVOs#SyDNkE>Sic0mCQNx6}PpYhR?`FJvDVL^le9gW(3~?VKevD!4{FF$%FN-@MH@@
zXSo$ASLJ|N1TwHx+-IRvw#0DG>beB_kj#lXU#MeVGjn|yRBH>g>#YjI{X^yGS
z9ijbX9+(BxbXQ=f_FlX^S~Pk8;_HgM$->b-_IDn2bZei6ln@VmQmO57%&Guw{#U+G
z`Sflfr|g>HY9O<#6|bSEW)U0dI{f$?(!sdS&?r6zPay)cHd$%H86oJSAw;63Q;_c@
z``>;xF$tuq{NX7umXqcT;pXL6Xu4|*Q=96u*$>2yXy`6{wDQ;6b(X0MYc{svZ9nZ
zlMN+yEP8&P>E44M739F;lmWw;WNo0Ol|ZsCxMWCfQst2cdg5PBW-K5Br3Zc^Rt=%|
zm(b!McjHId-q#!a=)}mG;O7`
zF(1{U07q1K_RE-xR%=LjRj?nxs$SXW&Ro&M%J0o7v!7r>s!D+_zgjI4QS?u!k2#{-+|ra%uBC_*)bQh)5Io
z0)3nWal1*Hv+G0%JFVqr|2|?H;N6UKp%0$hi$8CE<4!;|+z$|KsqnM(I@WpLYKq9R
z{paB9tAA!U;#%7Jp>#kl>W40ru^G_aJp9VKUp_lx{uY}M?&Wv)rG%8T%Px(*GFIo6{&6U^g_?I`dxBw5kyv|(fj
zi+|i3Qg19Dz}}W=-r?;*d$b24ya#yN2riET$}c+b(!wAw`S;_amw3}n0k1jUbqpgC
zErmjvnWePqu%X`gnHRQ&fKo!Y(&lUvTujq4*N{Ka=dFMErX4GJ&4#nBVbq9@{Toct$#z!v0j}+hAP4Z*t1>JWAdu
zjP$#GCw?-lJ|qC3V4k0xT5L!*?HSe6r8>s5juyhc)HMg-J$&LgxSTgwbU`&J`M;T<
zW*e8>l|s{p!SYhftB!_A4Ny~)U)W$5`cihnG
z^m^jjOsJTg!8cUfgPPSaKc(jZ6=Pr~DG+cbW1XK!A@tI{!_MH@jGo^BuDED7)*AX#
z_9k0-;@a~Ut;nav!=3nxb~xdumb30NFc_1Jcwkfnfk3utKv)CjK3AL+W*-e;F^^fB
z6t#5LwtmpRPkT0Bb^=1)>UOQWM3aLq)%zy-hzXTNRbn=oW!jUVFnxfSx(0Hw)nH2p
zxxG|xbKyKo>5ibzvgim?T_^3-(}p&l`rMZlB2kB(2xD$8`l>h|_1c$HzGTqE
zSFhZSm(c~wrHeG3iPz6Z$b#^lWLqQTHCYq|f`XB{9XU1_2B=xqzi=!}&HDM4)KH8T
zcM=0OceB%*P>L=yct8ZBGnK?}B3}MU+36(Ft7^YI)1EnZUOki9dyLO@GI|OcWof%`
z^<175NV-}oB-2h}ce;20(@89!zit{nN-w^85o-;Pmk3b3}=7K|zwh?-L$oWMC4S*AU
zp{fIRr(>4F7{WH_Gkel=gaM0IG_}9!B13V}ZMCZ_e`rDwxaS@uGMp>FCvqYpAlL_A0qC-j|V#JGiusvUiNC
z7S(AJ!@bl!(&upe0=EUW
zIGfA(TX4A-y1(y`{nA%{V;XNcKP0!)5xFo;262~R2^h_Sp&pf809K{WOg5U53b&kyOVS2KFd|SN*E&vZc?r3Cm+yTcgPwyY>jV!=9x|
zDAcO*;&Q&y2@mq&U{NA#AixeqpQVT@?S17GEQ=e7l|yQXf;?j&#xmH__w9GkF{=BR
zij{U|DYxm(Y@#YEEuqD)09oK9-SI|44RRQ9lY)nJnrFSfD%}%@OEh&3XSF9LATNBl
zfXgA2Rhj%wOV_ijeOgi&*?-41S+37}Q$CA#4mt`YX+*x96oUQd;%pd~b7$eb->VTB
zb_2(t39Gwc?yIaW$$xT@HnEe{Y3is2JR=c>zQFo_L6atMqfbBS8R-!|u#r~;gph4{
zr}+bc^3*jtZV}x!oeh88y4=6EswX%&gE?ss?N&xOqqrq~HyI`7nm>Kp)Va}Ugh)o~ZP-y!^?JxdIY}e&%_hzia
zqBEV63GgFv5}*n&%8A>a>b{EQuvJ|04-}w0!lGvjlIoMYUVrkbiv~7?uti$;>J=mb=;y?$h~(DHD@`hRF6IQ
zEEQ?fL0-}XlY!E0(yzTNfZ||)Lm}`_5BA;Pho8u0yH8=?3p+ei*$*4<-R9X(B<9?fupcS}u`tj97hn!ZFD~&0=3oeFY9hC5%
z?5a@FkQLhX^x$S#a&rda^u!be6RgzfrubqI+Y6xvqlpitfFNUN7%w4NhYt)hhvPqv
zOlAe)*H(R|j%7SM?>`XJzsZRz#Vm)NxJ4m;e#Aac?0p};$ddW6^R}TWiB`G`r9_ei
zVMj0<_QSmOP;1+@I*(hJEpH)AOknN2ZNDt$%UOq%r2hW<7WN3T&5vt^9w)j2eGUOp
z=%OD)ukb^m+a*bHOCB_MrK~rN
zaW!WWW(R8_rmRKqD-^W$vli|Dbbs2b#rLuQT}8hXa9U|>nPb2X6fEi?TjOshFc&S@
z$~N(DpmeUgoV|f*KIj|M_Mkw|{h-B_cCk56kv@LN5Gj^JE`}6i(a<5%O3E|fXnOpT
zuINbk!0->q$rj=i4E7vh5u~cTA2tiEg2VW1Zyv-4e=cR;Q+GFQZ8RqujN4E%3{IfT
zxa~#xhsep@sb0}ms~9{!q20TZ3%c&y^dRe-a-(dXZG9}xaI}#FxuMY48C6ot_gNhs
zerfR`507!aPXYU{pfLGi?eJDxxf|rrXlR${9cq&LP$0_TL3dQag!wv&4C28SJb)#1
zne<3oPeP>-2^qzj`sS2`ZKQwy!N$e`ba*6vD6F-fAdCCX-i<(Dm3<{f#ROoq^9;Bj
zKa3t*WD;aP1Dxy>vms4~TcAy+?9jikmjUi8r`HIGsQ$W$%buqT?$pC^FPDX^Q_Cc7
zBDBlWCiy+Uoz)%tsXFqp)(=0lU*pf?@Aqpv-<2`=-h^QJtESi#9_2^jNG**UGpH4p)Sp@*
zx*Rai?LlPl`TB2aH69DOjq+i+LQZWU=b3Gi&_nQ+IMv9BdK8Sl-1f}t!pbLCqvA(v
zhFBY%sXULod7n0S{+?q?<-h%+&0$(QnnMF4TaYUTNbmWIz2dEHgQypg*k>V2qRK9U
zUxGmfw1Jv(m^a>MrpQ^ge!lZa9MmQR(6`aargW{^p3CUtf&uBK6ES01k#^^_(c^}=
z7q8*#t4QGHA6iK-E+C;ccqO~cmpa2zdYrW8skRzTqRDU@Ey_JCdp0?*mF8ER`rEaC
zav>Cpb(O9!^&}5U@eTYjXX#dcAkE;QF!C^vhob)oEj>HD9RB*e;l@)!0kl|{LnI!B
zN)@MU&PbbalPG;i*6|Za;6`(I*(@AH%f8>9bR%Hw1|C`l`no+-^jc^dj%H8Y-rl3o
z8JgWX$Jf@{T>q%Y($Mwxz~i$
zloESH6Z)Je&vSmjJV7&{d-|bo390S+BmhtXvexU9rABQf7}Jk93n6?bTvV(ay^+iK7F~TpDAhIF0B~Yj
z_KU_W=n5|-MHBk=s}sI;?o7Mk4I7+Y3P8!RF6&v=bry1|n8{p14mnDLhl{djg0W&S
z?sncuB#;B}BgX$qZ7@*{!OK`xp}rd=)=zVgTQyE_{Kdv0r!ur%N6=LmY+&MM7nA`{
z;xxqG$57=+uDW-O-?PUByNhHcY8C0J5t$|4Mp2rsFP!R>CM(z0qHfHxneSL>hM*JR
z?Fu7)KQ;uR#LwdzZCwtcfrFWBp}u$vyIuU+x-cxfRl`QVdNN!e;M*an5Sl#q0XR!~
zh4ocIR+Y*&&PQ7QW)ld&uZ%;~Q1#^SlaPd2jb`^>PO-v7^k(p2^_^}(WwEWD`5X?&
zresge?a4wAK1?+
zu>OVfq`{1N><;-5TFUXHntnvsO3es@
zvuxTC#pqQ(7$Wk2TBzHM)pI*)36iyQjnV*a#85wQyurIlvfu6GRU3u(U!V4dUhD`t
zuv)@JmpD5m7tR4~F!tWHlnyty7OOxezp-L#T|ZBy$o?8FVxgws6brWBbwA?5bY
zbgl?CSU0_=Ue)d&AX9PN>46Q4QU*fn)4J%h*7C|W=Nbgr&`>+6#3k1sj=QgZM-{uv
zSfNMqM9lMRu-A-6@~Je~&=YQ*QGol?XBx2XZXhZzU86&xV=3!nT`=Uc_KQsKU(}Fm
zlEjuSsR(~}dq>tPzFK!P5b?E*eL6Jg`0=wyO5Kg*_poh1Wjf(>X9jekXkY!JZSU2plyr;sag2?-?@ppp&
z@83U7L>j`YxrFGD#S~bpL6lV6q=DO@)?&{OcwM$bX)UL9m~J?(3uWpIsCH+HgdJc4dgIXR<;5nv2}
z$W3D=Xzy~4i!7J;T1%_}R=tHu%~tolKvJN5gaKTPsj!Nvrc$8*PZ(QB!U{0ac_>vy
z+8~B`frR?cD8bd+1_^z?NK50(!nFnJ=w`OKTu;6r7{c7PoKRUZTSgY>6!Pb@u&lX&
zaGGQ@n^7e3{8hj(F$G&k4YDIbN#`kb9mKQh=`)8WtESz1`=<03V<
zcLD)ZP5ybe(odNYG|fW&?h*d?Q*UI`1hb0ig`hS
z=HQR)0etHLqhj2&c@SobB*Zww9ld@vLjd8KwZCqk`PwuWfiF7HWnLQV2v58|3B@|5
z^$;HmsKob&>=5rWiW5f^b3q>OS|aU>F^TUFa~x!qOX`4~pNhLOy9566vfB;`on)cZ
z(VQW)c{AfZBQ1amr|I?=t%E*XX>HQ(utg{@7|3D23}>f=j*JIAyL1Ep`7JYNh=S+o
zIs(O58~Y_}!0efdmXfmX!6GOlqF-V~r{?ZQK;VNL#afrBm1&s=jz#USw4zo0${}_Z
zbntLPV)B{(zW2*OBr{6px>7DQDGS;9E!}3WSSYqzw3tHynl=N%D$RicRR|@lyyl>%
z#A~7|@wBfuY)kNNUxzEAxBLubgXIAcbD`M4~-kgS}F7^f8H9
zbHXFb6s4>CkN8hto$fI}Z*1oyqOY}2KSU_5^y6OEuQkiuaK`Ihyy4-YwiPY#9H%tw
z=l#XM?@-5p2;GA|Rp|+rACyD?e7mNR{*{)QZXyUKC3!?LOFalrfNRP8Hh>PgAIkxM}VIms)b$0ZYZq
z08|R-pO*r^X?_}AKahY?HVkxMHSus^3b$6kRT&L=(QD5%hjmT1r|DYldBQ2rs4egP
zPWE8R(O$z@QMq$e&6$#N#~h<$Qp5c4(P;5Dg4`;Z(BCA3S5E0pd?stMmMtz`){O|j
zz9jEIxbt}4LN{$`&?YNDwveZCS^uQBUY@`@;0_PsoAb>p_C&LuJ`;x8$tc9Ya`+jqe9Y`b?pegUkJE
z;SpCRW$_TR>USH3(DPy|Z2C6O5*D!jVZV49D6H#>MN>n&SJd=B^hH-(`sTct9#gGH
zHkv8X0Z@Fwp~IVIGKDGs{l$-s6>q=GG;9~MQkdRx*hyyQ(4z_LAytmUL^OY0!j)cZ
zBv+&B0%#dt-Vw~whoO1!0bx7_x~J5%5w$)K(ZocVe^@Ep}w(FM8b10A)jPsrJbR||j<
zR_KP(`T0Gnqm%b7mBHfizT3ei`H-S>0=GqVIIIJa)>BvmcwBGbrc1b@>z7Q~vo)R+
zZ%D^;KZ#g&UTFP8K!OLj3xUN!l=rvw=3zT+Y-D~VYaJK-;823hh^=94TH<-F){P;+
zQtgRqD)+hDNDGPG?zW%JsOO%?d7T)&(8WUrjIs3)AW<0YC=I9jn;pLwdtbUv3GdZ+
zv6FR+yZbckSTqv?V#QpvPW|eg7s`a`HL@3tTRYUp%_Zn^`yBLW%xwLXe`+ZGNP)58
z!&h#n-OV;tm{}%{dwkVI-~8Fu6Kw|(Q5!rmonlih^|N(M)FOEo4KF!wP~B;p9xvvJ
z^~w_N$OFPTE@@;*&;&i=g0!u@V-tyM#Gw60lH(k7rh5VF&COM$DTQ_t6f$;rf7?+`
zrHdNlt?7{)9G&nhLli?m7=e(0UTN~{`r(cdx9Xp?2N*0hwT&L0%6!&2PlY7Ez;crp
zB!NcLs2Y`=pk3k$&9&-`(|^1C7kH_%uDY|GxdXd#11N3RC^_RQh3ey0KlQZmLoHl9
z%KS;*>R0!x)=fV>WEyUJksj7mz_9mu$l~4@vK}FM%)8Va6fgeFs#`}<+)#je=GLSo
z7dhVbeA|(MI
zOE#Kll}#FOiRf8ZUS$yYlfq@jbbjgG5imrDy<^oo7iDtY6di5%I=_D8NXV^Ov1lLa
zcUCyH&qjx5kz;=$h8u@PJ6(}9HW^fWp`BS%(~5B-aXL%x8=3f-K8-D%1;%dLH>IJ!
z2Wsm}JMQo%tbhK~7gd8%#@LM+
zN9^n{m)rjtJdAuyF8E(wv||`=yO=GeoaV}O>(z@4DMM<^f)oy0*)~t}C(Y#hBeOQQ
zW$=K046P6m64=>cQll8E1o@zka^k*ZV#jyxS9f9
z#??(T(`ysb_?Pv1%|txt8(atV(4HZupZso0DD1nIiP14pM<-7Ow;HJ$Xt=Ly)jC|2
zx`h}2s=%XwH-tH#W0|u9$cQk^?oFx29k;-cDG>@&Z%G3wjqXUPL2t|WVsF<<_@?oL
zl@QD125O_>S!Q#BlgDV_WqFZxzO`_-OL#;$PU#R}3*fuX+M+W(;3Ezq*ICHj?>tfVM@Qvr
zfx<;?5mmBx#j*Im&3Z@w!UXsNq@kE}%n3!4ow8Tc!Zb;IuUkT!tl;lM|7D=c08FbW
zVxI--DiX3r0LMxY
zsvkw)sCB6$?G|Vlfy}G}p-1Lr(}Y&-|A2)3H^{ZMSrlrBM3+OV1k*EJ3lKn_%emc`
zQsxX2JT@WHJXhD#lhC)mz}p#4;>yu<5I9PizBHnyN-N`|`x^u*8uEM?g0QFwp$YFt
zv)rbE*ay6$uE=tyi^#WdM-A>bOHufc5Y0omId%i1!uw~SZfO#MI_SiOAj(>nbfx5X
zgOStIy8r7TAlR?*o*r=F5b#-02;AZ5VBnKl^Ca*gm|9TCT;_2ombOF>+aw>Vnpb>m
zS4K_>gFh(C32puFkD!Py;HF60#4qC;k{bL0FGDWH=qvq;7z4V`Zp_gfdLk`;bgn_A
zFh3s*&s0LW^`F#M|3KY_Z#C_pJn&;j4GieneBPT_qU>sI%HZlo)6V((t#hne>OK*Hbw1qT;p$P7X;)+luv{pHB@y%Rqj=6+F{S%z
zDCnFO@;aQ!Q*>h@)wKt5NM2jxQopEk?$KqWt&B7M4>d;TJrX5?Dyfv6Fu%p(PO^Xm
zn);m~jaH7DsJ+oQ~b-py4AGszm@g493XW%DU
zk?41)dhRtTT`Rs@fVHF^?ccETN#J3*rexk0We!;T<)8bV0F^kA&f6LZ>$qQcLePvD
zrxnsBt6EWrDu18mexPO^T1NLK6E-kA%nMVTy&H*}(RAfX8?69x!A$2^e#B=zw#g{V
zakzc+r@`4P@7Xyt`+^d4foX~Sn$1LK6Bioc@;vL_o2=*`vLbD5jI7e#OoSQ~7Gpr(vc{gbT
z^BGvtHnb~%@{!Pe@DSVFaDP{L(ZSpXc^qQHSG=^da22qe#=JWZ=Ibtlq&!OeB;TcW
z1&+~w&BW^Hcjip?w|EylW~-y-C!F3emH4H@;v&8#(4%B4K-e&vf)D8#j}m8LDIK`9
z>Pc-{TN_9&1z50oE30*MjPSJ~(Yd0Ny<(x>{GHo)=Wa~6ecE^M^
zxM2Vw?m;c|=QuHUW;FM^tJs%fP2i145bgzQcngA9%oFHI3iFb>M%uV22iog}3<6$j
zkFK}He0XSi4+lPdgbHk*YJhG81W6Lx?1JdYR5BR7m=D0mcO5dzYnZ&dJ^%u1zhd@R
zT!ChL&<+j<+3nnSFfyz=eP964>HC}=wZ)M>*7v1cRf7~4a26UO9srSt7+htS+PVN)
zZtXsad5*%lPuvVl$<8iip{Vic@b#oFcU3SY1;|P5gYcs}598y@;ih)|VB-WnkCqjw
z(-|Cuk8D^C4NK*)9=yHXzU$f1u15XcO;`Vm*q`^&b{gQ|`2p1y=?1KUaMmA6J%k7$
zQI|aMEZji>cTBIjK_$*XRliLf%3`E)kvwTCt+}pfZ~WifG+rX>I|U4U-r^lUFmgy(
z?>lhm$&7Qwr!2#UY{`%Fu3*eSYuOX_g)sAFzqGOQQZIc$zVK`_hIf
zz7KrG9`C4I>+e|%G+qXQY?4xMFWTbkv4q!iS}L4@2h(Hl#dN+2{Z`U1#{011V!HBw
z{0z5=sOf>=?BV*0fD&7QFl~R8Ay?J_*{}-Ythx8ff>d7|fJG*Fmld9MO~2rOs0R~A
zy7_Yg!S6TpqnlhhVyP%N1xs8yz1&djrwkRzdh34qB@m55fWnEG3B@H<1bArrsGYnOEp}qpT6zLRE6_v
z6n$O^^QQzLhyTrc0;xDT$+F&&PxNxr<~7#x4b1pHN~&A6N`=8K^-)vs!0Ge7>8CUyk+4!;h(hj
z4U*cW`P%^g;j9gO)PxUd!+}F*`-qn;W3MNnq4e7FV1Jm6+N9RNSU!4T
zNSqsW3-X?#Fx;tf9b$ME$0GG#B;t<4?>qw8;9nPBjk`mY<2*PweX)_giX*9G@5&)#
ztFfdH7-%=+_KyGe!}_0qV*t(B)Wo>_wM%7bZZ6;y_oV&?e{CH4Cz$iUqZz{&vfk6Z
z-I$yQz0>=IX1=}n@+J`4Keyg;_}4NXr=odW0omE#F2!>)t+I_k}~eP4TU%m
zzxihmJKx#B;D>M|33CEHFsUC%0S+3P@9ap4?0qo93Ca=!wj>TV8MRNBCutdTdpRaS@~+TR&&NV;91>8HULHu{kd>Slrb=?EaBhTh4rMQv>w>)$+zpAW$5_g
zi1@+g{oe#i%0<*zyj1+xGQi9^QrC_o&CzBgP{s5&yvb%t2J-b|-Z~Is#mUFMDsQ08
zh22D3yDk6&MhgSaLykIW32$xm=t1BqqK|)1P+0#bpr%F8^Po%7Zf$?aPzL0|qNf91
zovG>r^iclCzTi(S!(+U;rd6KZfMZRe`&^IO9u4rX=pe(y3aOezD&RpH#J)p4?>%<+
zFxEuoul#HElsyq_qUp0ue|^oS&1oYCP7YzXevxxeQTm3*>7L}$te?L(W5Qo4SceL>
zvjdh~mQ^wVx~=@OyE?rw_JM5MGIm1kkYJa!(&Ro#f;54ut;<
zAXC}jUP*ZcX@v{f2Gg$Gu3qcfc$%9E$P&sba4vO=bV(u(I*BBU!Q&o#g6=bEeFckS
ze0%pfNP`KM_rR=pe58vwUZ_apDlbpOSHD}hC=`vQ=r4~0w1wfnFr!|B;OqeRoOH{$
zHzaFL1p^^J=b}Lo{wP&z_0@8_wk$*GmxffWx&AdFa?+~yh3;tCoU;v^pHf4xSVykO
zdp}7gbTivmBX70`=TLkSJE!F!G>ETKm>!o|7tX6c%FE?MGwx)GyP97hwJ;R1ipIyvbnW;p7m|r0h*WT8_-J5^B_@9wktW
zcSEP^w%w%xx(euc0As&orpQz;b$}G&MPq@C6^fswEL{#OnH(+rply#I1Y=;>j$A#a;6PJw0mZx9tX4szN6
z+FsFgdGp08No&-oh4-2rf|0XtEz`)$Lg?l07bmnFm+ox&2KbNr}G%k2}NYlc8B>uRhkcr&q|xJI2@K%iLHW+ZYzt
zX3dYivrEcXtjjqd2m4cRGC2h28N@gYtOpe>oA9SRy_|KL$O+*OVjHFD7Wh=mYk(&;6Tv)@JZd>b1Yp)(kUP}`ZtRpHD2
zIJ_)vsc{6}{GG1B+UmoAa)W6!3ZQubG!q>v@FJDiU5TZg;CD>NlPLxe!&)u(X(DOi
zSGg6{*nQ`Ir%H>1r-mn-)iB>_XYB6&6|t1HdVd#t)b5y;hcXPSNB?&7Y42?
z7sRZiQW)Mg9`ULw!lJ4$O0EQG%ZzVrHmlTJgZ;AZUHy%$7iZVBE(o;~Pk%yRZ{{dO
z_F9`sPJJS)D01N*bQ5AN;?ttvuqMv2y>VbmTy3a})2K@SR*EnXm9&lKjKrYg8TP>alA8yYak1c-wj59fr&Gx2s7?CdWQ4gDY>_g)ye2D%fRrKP$fNhFd}+Z@z^=@-2CD4P$wj*(&rWS???KQ!$17q6By9As5wm+rr&rO>YmBzN
zS^lttm?i>e<~MA&HiKf0)};fNkAYN4hupek7w>#z!L6v%y1PQM4uGy-2WlXOSyxX6
zamkF#4Be*A4xRJefNJjtitoGvFv^r&c-2e&MxH7Hqmg1hl6yJF*>D~WYWTf%7W&7c
zaHiQb?1%54;*m#LVy_W7A^Di%dHkGz8$8V{GT!4VxD$KWT)~X(NHHuDHCDxNNHegn
z__*l<7j4z;*YkiP1#tdS60$oSwL*MZ37E)wU-?1=lG?y@WBU%_MC2*@f-0J5~|&i4HVBuO>#wBanqX>HD5o`smGP
zU*g{IFT2VICK*knq4qDUe_U&trS}6F(g^*@v@E)MZL*pbPvZkTOhT>JI4x$nH@2-6
zc3~eAi&7oP%+NGBmJ2CUEz+l28BA~uAxq=;i|nvzVYl)g1PSWqlJl`9r6z&<)^VEk
z+`sI2na}xMfw=nGL(c4mRThpqVrpuUe{j{}KHP1e4>OW{W5H~1q8XUf$oOB8f<*5G0nkRde*qfj1Sv&3h
zGKUGx_}$63^^gKLJU3o_-NiP)>n0!S7rwA*oR6aYG$MMfcERx9-DvOuirwhy*c}}EEj@QtnwJ6oJFZ>AkmDk
zhKqVFYIry3+u2Rn@2KOD)}12BOPr;LVIJ1at<<&arE-x3cWn@Q7@p;na>);e7Ac8S
z$rn%3AdjhV1xELL6@e2qpYTJE5U+8XW;>nA<(6XEN#DJ4=K9m@=U8794i};#U);ps
zyZy`?b}gg%3uqTi`o~1!0{AI}7?FL&*i%@qEF(Ew6rCd_Jd9Gfh2CEWiL&;wc5s=D
zc5tYXt{))e0J|&l`!Q$ho#y8K+~
zzhzRU7G}mLG>!V_apC#C^KNf4cNH9?NlpneN7(kf!K%|j3BJ)z9a3Q7m-5(2$cn7X
zynbw9Vumb{C`kDjLbsI9G{2C`SBVt%W5ZMVMS^M};`|bd$_`3V@s|;BrN*)WUX|7y
zn8y-yTFIzB0Lq*Qv*hF74yZDQD^ePOpAEEJLW*^ND2CfxOlyWrKg>u__#qUr*fCqR
z@57X&LWRrEg+66=+#0M=o2ZD*Er%T+)Ok~{G5>kTwuX=ps#Hg8)S^d<;maU|=kqX<
zn#Ejvvq0Fk$xHm%zpNmdrir6_7my0c%+p*A1T%anO<8v>%+)LrVpR>QaL6^^!fJBi
z5xlb2snNk3Y@bIhsfx5{bIqTi`&{VgLH2A8#Eoi%%K4NYkgr9O^ZFwa7U0V($WdKr
zo;ND^qGs4%)g?V_6`il=#na*94g6T+EIz@d4}dz?502X4;(64EYh_V?e86sFfO|#b
z6WdT}fBS9wnIgI$%T>FDKGBD&6z=U=W%T)Jpgok`!&p0Awx1D6~LUqWuIDxT65V>F^d%sYkLS`&*Vj4(_MUvG;lVWA|E%p
zD?bx6(v||h0DC#jy(X*6uk|VP=7-b_F*tmJu6CbSQE7ujwLRQhPIZL_iTm^U!XOLR
z#ibN*_rh(DolU9(=46o5Hr_Pxhu@-y0F%rk1l}Zuf%u_ujdA(OVGXc_e+=;3#A#e>!Q}-xnzG
zn}0}Fx6lZdwtO0)Zf^x{x;<4&Pn4%;&6pXhPaYbA$9OLOCy?AJgMl-Dv
zj8A0COXc>iVuS?8&8H90IWKOniJUqNi?bu@nGz9snKFI#WXR=5vcZ<-7<%xwi5gFU
zhcy7T(cJn~8iM+&WFoZAZf3%3q~>NLd8#vIh2i(FDZ^^6Phw%%$m1~-)u;6*s!*BA
z>zlBoY9HIoNhlE;vt1`%oZT3U;Z#y)W_jUy+O4mPM(uOm
zp|wdU;b+G_L4*ws^N7ldLvXq17lxYjl|z>^k-$5b2OQ@i+!fXV+~qhlBOqKn-^41nXm2()}Rp@coJ
zieH5~i2UbSr64y4cLt7{ws#Tv=>wouB^nB-4&xkYuI?avIRol}&q=C{qSn8OiaDa*
zhbaJw+_WeQxMt63jp}+ZdqCA6p{Z=L4l`(u&qb%Ai>J6lL5jPN_>yUdYRm3>wy5mU
zEn9h$!5r#NT%oo8Dj^%P2ri+>_=|a@(T7(!CQ#6%aMO&~ofoK!5
z!2PTJg|}0C^~(R2#&(HP=+%}$AH5v10CxRtP8Nnbo2@8ndcB^4_aHy2g8#f&>PBr&
zCILGLI)6}+jQ#=KIZ<5>=b)MIe71vk#M~_-`kEBD*45gTjJlAX$1h(7VoP{FhFEk{
zBuDM9<%jecr=9N7Y9^~)gQk`7k#96587ox_tpAYD&EC|;oqT8D->yj|V(E92ktkl5
z_Kc&bss2DGUvS_6_bj4%p40^kN$l)!sIJi%P5HDo%Zws&q?9rW<;m_qH??z#lVDIV
ztjXnhxBn37-M?K+D}$cGYE0xdUON
zj+d3I*Y4-ZBClU`886$X$2EN9qjgd85s_PJa%3_yHo`wjOo={vy#5l40hGmiKVNxd
z`){2B(o#Qd{!ZEDmQ&WCzux{)k7a!;=}J?3m`qxlpp2|?RnE}loE3;?=|GZT94f{V
zYK`B`*8wP@nCM;*C%}u19@BsT?
zJd1ycafciQZH~BbTyyX7tE;b=u@aS@#!c^UE>+1)gp0-l;-=|iXvudwp6Nn0vdj7y
zPE63bZ(7)HIOR&ky0T>f^{N#Sd}nPA`h5PVB6#=5En|#rb0pK~ssl2@vA#w9z47bd
zlMnpcztPH$vIv
zpi3kRBpFqUA=y+5(MeC^L^^JxHNI$!6JxW6oc=s&>H&lXoRQ_R|8#s)fBzu7+`lc`
zGN)srRO5qivZY@_JW>TLG>U{LZtBq^ZHf`Z#%Yl+eWI%?o~t{d^zHLr4XYEhZ{i~N
zi(C0H>H?gCTK)r#x_;EdJ(w+muJj~eT{YM7L0V<<$Qu#$psGUymL?&EO4E;Wt`gLH
zO>GNEi!D1)H=roEjLAVzFbLSD*8B92CTn6tJG)$gt3`|pHE3Nqj-b&BH!55k##wY?
zwz{X%7M{#%B3c!Ffl>lJwi*+0wSW3h4qhV>yqn0h-?3!6_A4#Qnpw=TYc6ER4cM-g
zyHCQ4p5cK4n5EVOnh=~c>a|Om1&52)J)&!dzDg;(yK9PEe$5$L=uYr;xs4T%@OjEz
zzhHqq^HD(k9|51HhoGO_yE0<3k;7NVw+M2$ZUCAyl=X}y_xuCkS5%a6!L7VNgedhf
zZPkXQ;0WH7?`v@3*dvn=dDP9_y5_4CacS3LCf(!!bbUQ$y)5qfXK3NA?b8L;zr|A-
zx~|6?U?QcOTH$DXu4;JDF~i94n@Gj`tQ};)uO?x+fbLA7zk?BKD+TN!`~6ODDpl47QmbSI2#eF9Qrrf
z)u4OY=YMX_^sl|*t-lv8;!Pi3lXd|$5kID4{4THlvRDDP$$9r^8k3(z_qN5%zSt&@
z4Ps>-)P+=ojFhSqmo6bvUR=ZFH)BMxiL{Emim=-dl!;B7ZOVS2sOggX&xN*fP}2`;1{(KhHAS;uqC
zOTxA1zJ8uKp(KRD0)GS9edup)xk0lO_W->Z3p68e_V!gRVG{2jT6EfgW?t|G%PS$3IU2rg
zIM4c+D7ai+iI#|{j0v!TiM~T+f?v9_?2*x7q5iP2_Djr1Zy4S7&HT|u(?XM5{n85t
zCUQe&M7ko|*>|4-vZ!=&VbpoB>Iau(Ci@Tl)wx^Qb*{CPt`&QjtQUedeYg}d#U1U>
zp3i-CTifDd?PKcB?i7YgYCg|6^ljZYEk|hSrU;HxVOB_Xfn@mXK36Ec7l=6LI#kg#
zoz)7~vquaBKl}f>!K~5}x){+n7;*jD(eJa-w7RJbzC-+uL^{2)L-?~f%jv9N<|IVy
NJEm}Vx^-|{0+<~!(@FpU
From f9c729597d5b77b05aaefd8ea1b77cee575bd801 Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Thu, 27 Jul 2023 20:08:53 +0200
Subject: [PATCH 055/285] fix(deps): update dependency google/cloud-document-ai
to v2 (#1890)
---
documentai/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentai/composer.json b/documentai/composer.json
index 326aafb6aa..062bbdc8ad 100644
--- a/documentai/composer.json
+++ b/documentai/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-document-ai": "^1.0.1"
+ "google/cloud-document-ai": "^2.0.0"
}
}
From 228d11906597506405a56fb2ef0fa117d64e9845 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Thu, 27 Jul 2023 11:24:57 -0700
Subject: [PATCH 056/285] Revert "fix(deps): update dependency
google/cloud-document-ai to v2 (#1890)"
This reverts commit f9c729597d5b77b05aaefd8ea1b77cee575bd801.
---
documentai/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentai/composer.json b/documentai/composer.json
index 062bbdc8ad..326aafb6aa 100644
--- a/documentai/composer.json
+++ b/documentai/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-document-ai": "^2.0.0"
+ "google/cloud-document-ai": "^1.0.1"
}
}
From 18c687234b2c72b57ea7503fb4806df701308e26 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Mon, 31 Jul 2023 00:36:38 -0600
Subject: [PATCH 057/285] chore: upgrade texttospeech samples to new surface
(#1880)
---
texttospeech/composer.json | 2 +-
texttospeech/quickstart.php | 9 +++++++--
texttospeech/src/list_voices.php | 6 ++++--
texttospeech/src/synthesize_ssml.php | 9 +++++++--
texttospeech/src/synthesize_ssml_file.php | 9 +++++++--
texttospeech/src/synthesize_text.php | 9 +++++++--
texttospeech/src/synthesize_text_effects_profile.php | 9 +++++++--
.../src/synthesize_text_effects_profile_file.php | 9 +++++++--
texttospeech/src/synthesize_text_file.php | 9 +++++++--
9 files changed, 54 insertions(+), 17 deletions(-)
diff --git a/texttospeech/composer.json b/texttospeech/composer.json
index bac8f0cb0b..18aec934ff 100644
--- a/texttospeech/composer.json
+++ b/texttospeech/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-text-to-speech": "^1.0.0"
+ "google/cloud-text-to-speech": "^1.7"
}
}
diff --git a/texttospeech/quickstart.php b/texttospeech/quickstart.php
index cc9b75cb5e..375781b657 100644
--- a/texttospeech/quickstart.php
+++ b/texttospeech/quickstart.php
@@ -22,9 +22,10 @@
// Imports the Cloud Client Library
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
// instantiates a client
@@ -50,7 +51,11 @@
// perform text-to-speech request on the text input with selected voice
// parameters and audio file type
-$response = $client->synthesizeSpeech($synthesisInputText, $voice, $audioConfig);
+$request = (new SynthesizeSpeechRequest())
+ ->setInput($synthesisInputText)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
+$response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
// the response's audioContent is binary
diff --git a/texttospeech/src/list_voices.php b/texttospeech/src/list_voices.php
index 8f2f014ecd..9fdc773bac 100644
--- a/texttospeech/src/list_voices.php
+++ b/texttospeech/src/list_voices.php
@@ -24,7 +24,8 @@
namespace Google\Cloud\Samples\TextToSpeech;
// [START tts_list_voices]
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\ListVoicesRequest;
function list_voices(): void
{
@@ -32,7 +33,8 @@ function list_voices(): void
$client = new TextToSpeechClient();
// perform list voices request
- $response = $client->listVoices();
+ $request = (new ListVoicesRequest());
+ $response = $client->listVoices($request);
$voices = $response->getVoices();
foreach ($voices as $voice) {
diff --git a/texttospeech/src/synthesize_ssml.php b/texttospeech/src/synthesize_ssml.php
index 7a0fe4469f..2b58b786f4 100644
--- a/texttospeech/src/synthesize_ssml.php
+++ b/texttospeech/src/synthesize_ssml.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_ssml]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -50,8 +51,12 @@ function synthesize_ssml(string $ssml): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($input_text)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_ssml_file.php b/texttospeech/src/synthesize_ssml_file.php
index 7ccd1e1290..0682429963 100644
--- a/texttospeech/src/synthesize_ssml_file.php
+++ b/texttospeech/src/synthesize_ssml_file.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_ssml_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -52,8 +53,12 @@ function synthesize_ssml_file(string $path): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($input_text)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text.php b/texttospeech/src/synthesize_text.php
index ff441cf9f2..be27fdaf79 100644
--- a/texttospeech/src/synthesize_text.php
+++ b/texttospeech/src/synthesize_text.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_text]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -50,8 +51,12 @@ function synthesize_text(string $text): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($input_text)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_effects_profile.php b/texttospeech/src/synthesize_text_effects_profile.php
index 14acbf554c..2517961289 100644
--- a/texttospeech/src/synthesize_text_effects_profile.php
+++ b/texttospeech/src/synthesize_text_effects_profile.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_text_audio_profile]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -53,8 +54,12 @@ function synthesize_text_effects_profile(string $text, string $effectsProfileId)
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3)
->setEffectsProfileId(array($effectsProfileId));
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($inputText)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($inputText, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_effects_profile_file.php b/texttospeech/src/synthesize_text_effects_profile_file.php
index 80fe8033eb..a437bcd4bd 100644
--- a/texttospeech/src/synthesize_text_effects_profile_file.php
+++ b/texttospeech/src/synthesize_text_effects_profile_file.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_text_audio_profile_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -54,8 +55,12 @@ function synthesize_text_effects_profile_file(string $path, string $effectsProfi
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3)
->setEffectsProfileId(array($effectsProfileId));
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($inputText)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($inputText, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_file.php b/texttospeech/src/synthesize_text_file.php
index db7067f254..91df4bae23 100644
--- a/texttospeech/src/synthesize_text_file.php
+++ b/texttospeech/src/synthesize_text_file.php
@@ -26,9 +26,10 @@
// [START tts_synthesize_text_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
+use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
+use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -52,8 +53,12 @@ function synthesize_text_file(string $path): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
+ $request = (new SynthesizeSpeechRequest())
+ ->setInput($input_text)
+ ->setVoice($voice)
+ ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
+ $response = $client->synthesizeSpeech($request);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
From fa6f3a4cb7238a7ae00a32be5b18efd9ec9fd0de Mon Sep 17 00:00:00 2001
From: Yash Sahu <54198301+yash30201@users.noreply.github.com>
Date: Mon, 31 Jul 2023 12:15:34 +0530
Subject: [PATCH 058/285] Revert "chore: upgrade texttospeech samples to new
surface (#1880)" (#1902)
This reverts commit 18c687234b2c72b57ea7503fb4806df701308e26.
---
texttospeech/composer.json | 2 +-
texttospeech/quickstart.php | 9 ++-------
texttospeech/src/list_voices.php | 6 ++----
texttospeech/src/synthesize_ssml.php | 9 ++-------
texttospeech/src/synthesize_ssml_file.php | 9 ++-------
texttospeech/src/synthesize_text.php | 9 ++-------
texttospeech/src/synthesize_text_effects_profile.php | 9 ++-------
.../src/synthesize_text_effects_profile_file.php | 9 ++-------
texttospeech/src/synthesize_text_file.php | 9 ++-------
9 files changed, 17 insertions(+), 54 deletions(-)
diff --git a/texttospeech/composer.json b/texttospeech/composer.json
index 18aec934ff..bac8f0cb0b 100644
--- a/texttospeech/composer.json
+++ b/texttospeech/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-text-to-speech": "^1.7"
+ "google/cloud-text-to-speech": "^1.0.0"
}
}
diff --git a/texttospeech/quickstart.php b/texttospeech/quickstart.php
index 375781b657..cc9b75cb5e 100644
--- a/texttospeech/quickstart.php
+++ b/texttospeech/quickstart.php
@@ -22,10 +22,9 @@
// Imports the Cloud Client Library
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
// instantiates a client
@@ -51,11 +50,7 @@
// perform text-to-speech request on the text input with selected voice
// parameters and audio file type
-$request = (new SynthesizeSpeechRequest())
- ->setInput($synthesisInputText)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
-$response = $client->synthesizeSpeech($request);
+$response = $client->synthesizeSpeech($synthesisInputText, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
// the response's audioContent is binary
diff --git a/texttospeech/src/list_voices.php b/texttospeech/src/list_voices.php
index 9fdc773bac..8f2f014ecd 100644
--- a/texttospeech/src/list_voices.php
+++ b/texttospeech/src/list_voices.php
@@ -24,8 +24,7 @@
namespace Google\Cloud\Samples\TextToSpeech;
// [START tts_list_voices]
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
-use Google\Cloud\TextToSpeech\V1\ListVoicesRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
function list_voices(): void
{
@@ -33,8 +32,7 @@ function list_voices(): void
$client = new TextToSpeechClient();
// perform list voices request
- $request = (new ListVoicesRequest());
- $response = $client->listVoices($request);
+ $response = $client->listVoices();
$voices = $response->getVoices();
foreach ($voices as $voice) {
diff --git a/texttospeech/src/synthesize_ssml.php b/texttospeech/src/synthesize_ssml.php
index 2b58b786f4..7a0fe4469f 100644
--- a/texttospeech/src/synthesize_ssml.php
+++ b/texttospeech/src/synthesize_ssml.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_ssml]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -51,12 +50,8 @@ function synthesize_ssml(string $ssml): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
- $request = (new SynthesizeSpeechRequest())
- ->setInput($input_text)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_ssml_file.php b/texttospeech/src/synthesize_ssml_file.php
index 0682429963..7ccd1e1290 100644
--- a/texttospeech/src/synthesize_ssml_file.php
+++ b/texttospeech/src/synthesize_ssml_file.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_ssml_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -53,12 +52,8 @@ function synthesize_ssml_file(string $path): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
- $request = (new SynthesizeSpeechRequest())
- ->setInput($input_text)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text.php b/texttospeech/src/synthesize_text.php
index be27fdaf79..ff441cf9f2 100644
--- a/texttospeech/src/synthesize_text.php
+++ b/texttospeech/src/synthesize_text.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_text]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -51,12 +50,8 @@ function synthesize_text(string $text): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
- $request = (new SynthesizeSpeechRequest())
- ->setInput($input_text)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_effects_profile.php b/texttospeech/src/synthesize_text_effects_profile.php
index 2517961289..14acbf554c 100644
--- a/texttospeech/src/synthesize_text_effects_profile.php
+++ b/texttospeech/src/synthesize_text_effects_profile.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_text_audio_profile]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -54,12 +53,8 @@ function synthesize_text_effects_profile(string $text, string $effectsProfileId)
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3)
->setEffectsProfileId(array($effectsProfileId));
- $request = (new SynthesizeSpeechRequest())
- ->setInput($inputText)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($inputText, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_effects_profile_file.php b/texttospeech/src/synthesize_text_effects_profile_file.php
index a437bcd4bd..80fe8033eb 100644
--- a/texttospeech/src/synthesize_text_effects_profile_file.php
+++ b/texttospeech/src/synthesize_text_effects_profile_file.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_text_audio_profile_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -55,12 +54,8 @@ function synthesize_text_effects_profile_file(string $path, string $effectsProfi
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3)
->setEffectsProfileId(array($effectsProfileId));
- $request = (new SynthesizeSpeechRequest())
- ->setInput($inputText)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($inputText, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
diff --git a/texttospeech/src/synthesize_text_file.php b/texttospeech/src/synthesize_text_file.php
index 91df4bae23..db7067f254 100644
--- a/texttospeech/src/synthesize_text_file.php
+++ b/texttospeech/src/synthesize_text_file.php
@@ -26,10 +26,9 @@
// [START tts_synthesize_text_file]
use Google\Cloud\TextToSpeech\V1\AudioConfig;
use Google\Cloud\TextToSpeech\V1\AudioEncoding;
-use Google\Cloud\TextToSpeech\V1\Client\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\SsmlVoiceGender;
use Google\Cloud\TextToSpeech\V1\SynthesisInput;
-use Google\Cloud\TextToSpeech\V1\SynthesizeSpeechRequest;
+use Google\Cloud\TextToSpeech\V1\TextToSpeechClient;
use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
/**
@@ -53,12 +52,8 @@ function synthesize_text_file(string $path): void
$audioConfig = (new AudioConfig())
->setAudioEncoding(AudioEncoding::MP3);
- $request = (new SynthesizeSpeechRequest())
- ->setInput($input_text)
- ->setVoice($voice)
- ->setAudioConfig($audioConfig);
- $response = $client->synthesizeSpeech($request);
+ $response = $client->synthesizeSpeech($input_text, $voice, $audioConfig);
$audioContent = $response->getAudioContent();
file_put_contents('output.mp3', $audioContent);
From e1c6ba4efebac487dc2570afed8e5476faeca479 Mon Sep 17 00:00:00 2001
From: minherz
Date: Tue, 1 Aug 2023 23:08:44 +0000
Subject: [PATCH 059/285] chore: retire IoT samples (#1905)
* chore: deprecate IoT samples
modify README with up to date deprecation message
remove sample tests
---
CODEOWNERS | 32 +++++++++----
iot/README.md | 48 ++-----------------
...t.xml.dist => phpunit.xml.dist.deprecated} | 0
.../{iotTest.php => iotTest.php.deprecated} | 0
4 files changed, 27 insertions(+), 53 deletions(-)
rename iot/{phpunit.xml.dist => phpunit.xml.dist.deprecated} (100%)
rename iot/test/{iotTest.php => iotTest.php.deprecated} (100%)
diff --git a/CODEOWNERS b/CODEOWNERS
index 879d0daddc..45d901e1f8 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -1,38 +1,47 @@
-# Code owners file.
-# This file controls who is tagged for review for any given pull request.
+# Code owners file
+
+# This file controls who is tagged for review for any given pull request
+
#
-# For syntax help see:
-# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
+# For syntax help see
+
+#
# The php-admins team is the default owner for anything not
-# explicitly taken by someone else.
-* @GoogleCloudPlatform/php-samples-reviewers
+
+# explicitly taken by someone else
+
+* @GoogleCloudPlatform/php-samples-reviewers
# Kokoro
+
.kokoro @GoogleCloudPlatform/php-admins
/bigtable/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
/cloud_sql/**/*.php @GoogleCloudPlatform/infra-db-dpes @GoogleCloudPlatform/php-samples-reviewers
/datastore/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
/firestore/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
-/iot/ @GoogleCloudPlatform/api-iot @GoogleCloudPlatform/php-samples-reviewers
/storage/ @GoogleCloudPlatform/cloud-storage-dpe @GoogleCloudPlatform/php-samples-reviewers
/spanner/ @GoogleCloudPlatform/api-spanner @GoogleCloudPlatform/php-samples-reviewers
# Serverless, Orchestration, DevOps
+
/appengine/ @GoogleCloudPlatform/torus-dpe @GoogleCloudPlatform/php-samples-reviewers
-/functions/ @GoogleCloudPlatform/torus-dpe @GoogleCloudPlatform/php-samples-reviewers
+/functions/ @GoogleCloudPlatform/torus-dpe @GoogleCloudPlatform/php-samples-reviewers
/run/ @GoogleCloudPlatform/torus-dpe @GoogleCloudPlatform/php-samples-reviewers
/eventarc/ @GoogleCloudPlatform/torus-dpe @GoogleCloudPlatform/php-samples-reviewers
# Functions samples owned by the Firebase team
-/functions/firebase_analytics @schandel
+
+/functions/firebase_analytics @schandel
# DLP samples owned by DLP team
+
/dlp/ @GoogleCloudPlatform/googleapis-dlp
# Brent is taking ownership of these samples as they are not supported by the ML team
+
/dialogflow/ @bshaffer
/language/ @bshaffer
/speech/ @bshaffer
@@ -42,4 +51,9 @@
/video/ @bshaffer
# Compute samples owned by Remik
+
/compute/cloud-client/ @rsamborski
+
+# Deprecated
+
+/iot/ @GoogleCloudPlatform/php-samples-reviewers
diff --git a/iot/README.md b/iot/README.md
index 00ef94dedc..cb74ef1206 100644
--- a/iot/README.md
+++ b/iot/README.md
@@ -1,47 +1,7 @@
-# Google IOT PHP Sample Application
+# Deprecation Notice
-[![Open in Cloud Shell][shell_img]][shell_link]
+*
-[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
-[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=iot
+* Hence, the samples in this directory are archived and are no longer maintained.
-## Description
-
-This simple command-line application demonstrates how to invoke Google
-IOT API from PHP. These samples are best seen in the context of the
-[Official API Documentation](https://cloud.google.com/iot/docs).
-
-## Build and Run
-1. **Enable APIs** - [Enable the IOT API](
- https://console.cloud.google.com/flows/enableapi?apiid=iot.googleapis.com)
- and create a new project or select an existing project.
-2. **Download The Credentials** - Click "Go to credentials" after enabling the APIs. Click
- "New Credentials"
- and select "Service Account Key". Create a new service account, use the JSON key type, and
- select "Create". Once downloaded, set the environment variable `GOOGLE_APPLICATION_CREDENTIALS`
- to the path of the JSON key that was downloaded.
-3. **Clone the repo** and cd into this directory
-```
- $ git clone https://github.com/GoogleCloudPlatform/php-docs-samples
- $ cd php-docs-samples/iot
-```
-4. **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
- Run `php composer.phar install` (if composer is installed locally) or `composer install`
- (if composer is installed globally).
-5. To run the IOT Samples, run any of the files in `src/` on the CLI. Run them without arguments to print usage instructions:
-```
-$ php src/list_registries.php
-
-Usage: list_registries.php $projectId [$location='us-central1']
-
- @param string $projectId Google Cloud project ID
- @param string $location (Optional) Google Cloud region
-```
-
-## Contributing changes
-
-* See [CONTRIBUTING.md](../CONTRIBUTING.md)
-
-## Licensing
-
-* See [LICENSE](../LICENSE)
+* If you are customer with an assigned Google Cloud account team, contact your account team for more information.
diff --git a/iot/phpunit.xml.dist b/iot/phpunit.xml.dist.deprecated
similarity index 100%
rename from iot/phpunit.xml.dist
rename to iot/phpunit.xml.dist.deprecated
diff --git a/iot/test/iotTest.php b/iot/test/iotTest.php.deprecated
similarity index 100%
rename from iot/test/iotTest.php
rename to iot/test/iotTest.php.deprecated
From c5b6ce2b2f820551fdad706dbe3f7e6f7a868a35 Mon Sep 17 00:00:00 2001
From: Ajumal
Date: Wed, 2 Aug 2023 16:06:57 +0530
Subject: [PATCH 060/285] feat(Spanner): Add bit reversed sequence samples
(#1836)
---
spanner/src/alter_sequence.php | 85 +++++++++++++++++++++++++++++
spanner/src/create_sequence.php | 88 ++++++++++++++++++++++++++++++
spanner/src/drop_sequence.php | 65 ++++++++++++++++++++++
spanner/src/pg_alter_sequence.php | 85 +++++++++++++++++++++++++++++
spanner/src/pg_create_sequence.php | 88 ++++++++++++++++++++++++++++++
spanner/src/pg_drop_sequence.php | 65 ++++++++++++++++++++++
spanner/test/spannerPgTest.php | 40 ++++++++++++++
spanner/test/spannerTest.php | 40 ++++++++++++++
8 files changed, 556 insertions(+)
create mode 100644 spanner/src/alter_sequence.php
create mode 100644 spanner/src/create_sequence.php
create mode 100644 spanner/src/drop_sequence.php
create mode 100644 spanner/src/pg_alter_sequence.php
create mode 100644 spanner/src/pg_create_sequence.php
create mode 100644 spanner/src/pg_drop_sequence.php
diff --git a/spanner/src/alter_sequence.php b/spanner/src/alter_sequence.php
new file mode 100644
index 0000000000..05ea5bd84b
--- /dev/null
+++ b/spanner/src/alter_sequence.php
@@ -0,0 +1,85 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+ $transaction = $database->transaction();
+
+ $operation = $database->updateDdl(
+ 'ALTER SEQUENCE Seq SET OPTIONS (skip_range_min = 1000, skip_range_max = 5000000)'
+ );
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Altered Seq sequence to skip an inclusive range between 1000 and 5000000' .
+ PHP_EOL
+ );
+
+ $res = $transaction->execute(
+ 'INSERT INTO Customers (CustomerName) VALUES ' .
+ "('Lea'), ('Catalina'), ('Smith') THEN RETURN CustomerId"
+ );
+ $rows = $res->rows(Result::RETURN_ASSOCIATIVE);
+
+ foreach ($rows as $row) {
+ printf('Inserted customer record with CustomerId: %d %s',
+ $row['CustomerId'],
+ PHP_EOL
+ );
+ }
+ $transaction->commit();
+
+ printf(sprintf(
+ 'Number of customer records inserted is: %d %s',
+ $res->stats()['rowCountExact'],
+ PHP_EOL
+ ));
+}
+// [END spanner_alter_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/create_sequence.php b/spanner/src/create_sequence.php
new file mode 100644
index 0000000000..f4ff6d0cd0
--- /dev/null
+++ b/spanner/src/create_sequence.php
@@ -0,0 +1,88 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+ $transaction = $database->transaction();
+
+ $operation = $database->updateDdlBatch([
+ "CREATE SEQUENCE Seq OPTIONS (sequence_kind = 'bit_reversed_positive')",
+ 'CREATE TABLE Customers (CustomerId INT64 DEFAULT (GET_NEXT_SEQUENCE_VALUE(' .
+ 'Sequence Seq)), CustomerName STRING(1024)) PRIMARY KEY (CustomerId)'
+ ]);
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Created Seq sequence and Customers table, where ' .
+ 'the key column CustomerId uses the sequence as a default value' .
+ PHP_EOL
+ );
+
+ $res = $transaction->execute(
+ 'INSERT INTO Customers (CustomerName) VALUES ' .
+ "('Alice'), ('David'), ('Marc') THEN RETURN CustomerId"
+ );
+ $rows = $res->rows(Result::RETURN_ASSOCIATIVE);
+
+ foreach ($rows as $row) {
+ printf('Inserted customer record with CustomerId: %d %s',
+ $row['CustomerId'],
+ PHP_EOL
+ );
+ }
+ $transaction->commit();
+
+ printf(sprintf(
+ 'Number of customer records inserted is: %d %s',
+ $res->stats()['rowCountExact'],
+ PHP_EOL
+ ));
+}
+// [END spanner_create_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/drop_sequence.php b/spanner/src/drop_sequence.php
new file mode 100644
index 0000000000..a2faca07b1
--- /dev/null
+++ b/spanner/src/drop_sequence.php
@@ -0,0 +1,65 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+
+ $operation = $database->updateDdlBatch([
+ 'ALTER TABLE Customers ALTER COLUMN CustomerId DROP DEFAULT',
+ 'DROP SEQUENCE Seq'
+ ]);
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Altered Customers table to drop DEFAULT from CustomerId ' .
+ 'column and dropped the Seq sequence' .
+ PHP_EOL
+ );
+}
+// [END spanner_drop_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/pg_alter_sequence.php b/spanner/src/pg_alter_sequence.php
new file mode 100644
index 0000000000..19336abf5b
--- /dev/null
+++ b/spanner/src/pg_alter_sequence.php
@@ -0,0 +1,85 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+ $transaction = $database->transaction();
+
+ $operation = $database->updateDdl(
+ 'ALTER SEQUENCE Seq SKIP RANGE 1000 5000000'
+ );
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Altered Seq sequence to skip an inclusive range between 1000 and 5000000' .
+ PHP_EOL
+ );
+
+ $res = $transaction->execute(
+ 'INSERT INTO Customers (CustomerName) VALUES ' .
+ "('Lea'), ('Catalina'), ('Smith') RETURNING CustomerId"
+ );
+ $rows = $res->rows(Result::RETURN_ASSOCIATIVE);
+
+ foreach ($rows as $row) {
+ printf('Inserted customer record with CustomerId: %d %s',
+ $row['customerid'],
+ PHP_EOL
+ );
+ }
+ $transaction->commit();
+
+ printf(sprintf(
+ 'Number of customer records inserted is: %d %s',
+ $res->stats()['rowCountExact'],
+ PHP_EOL
+ ));
+}
+// [END spanner_postgresql_alter_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/pg_create_sequence.php b/spanner/src/pg_create_sequence.php
new file mode 100644
index 0000000000..2ab15f214f
--- /dev/null
+++ b/spanner/src/pg_create_sequence.php
@@ -0,0 +1,88 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+ $transaction = $database->transaction();
+
+ $operation = $database->updateDdlBatch([
+ 'CREATE SEQUENCE Seq BIT_REVERSED_POSITIVE',
+ "CREATE TABLE Customers (CustomerId BIGINT DEFAULT nextval('Seq'), " .
+ 'CustomerName character varying(1024), PRIMARY KEY (CustomerId))'
+ ]);
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Created Seq sequence and Customers table, where ' .
+ 'the key column CustomerId uses the sequence as a default value' .
+ PHP_EOL
+ );
+
+ $res = $transaction->execute(
+ 'INSERT INTO Customers (CustomerName) VALUES ' .
+ "('Alice'), ('David'), ('Marc') RETURNING CustomerId"
+ );
+ $rows = $res->rows(Result::RETURN_ASSOCIATIVE);
+
+ foreach ($rows as $row) {
+ printf('Inserted customer record with CustomerId: %d %s',
+ $row['customerid'],
+ PHP_EOL
+ );
+ }
+ $transaction->commit();
+
+ printf(sprintf(
+ 'Number of customer records inserted is: %d %s',
+ $res->stats()['rowCountExact'],
+ PHP_EOL
+ ));
+}
+// [END spanner_postgresql_create_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/pg_drop_sequence.php b/spanner/src/pg_drop_sequence.php
new file mode 100644
index 0000000000..9dc6274d59
--- /dev/null
+++ b/spanner/src/pg_drop_sequence.php
@@ -0,0 +1,65 @@
+instance($instanceId);
+ $database = $instance->database($databaseId);
+
+ $operation = $database->updateDdlBatch([
+ 'ALTER TABLE Customers ALTER COLUMN CustomerId DROP DEFAULT',
+ 'DROP SEQUENCE Seq'
+ ]);
+
+ print('Waiting for operation to complete...' . PHP_EOL);
+ $operation->pollUntilComplete();
+
+ printf(
+ 'Altered Customers table to drop DEFAULT from CustomerId ' .
+ 'column and dropped the Seq sequence' .
+ PHP_EOL
+ );
+}
+// [END spanner_postgresql_drop_sequence]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/test/spannerPgTest.php b/spanner/test/spannerPgTest.php
index 59d3051911..113e0eadc3 100644
--- a/spanner/test/spannerPgTest.php
+++ b/spanner/test/spannerPgTest.php
@@ -447,6 +447,46 @@ public function testDmlReturningDelete()
$this->assertStringContainsString($expectedOutput, $output);
}
+ /**
+ * @depends testCreateDatabase
+ */
+ public function testCreateSequence()
+ {
+ $output = $this->runFunctionSnippet('pg_create_sequence');
+ $this->assertStringContainsString(
+ 'Created Seq sequence and Customers table, where ' .
+ 'the key column CustomerId uses the sequence as a default value',
+ $output
+ );
+ $this->assertStringContainsString('Number of customer records inserted is: 3', $output);
+ }
+
+ /**
+ * @depends testCreateSequence
+ */
+ public function testAlterSequence()
+ {
+ $output = $this->runFunctionSnippet('pg_alter_sequence');
+ $this->assertStringContainsString(
+ 'Altered Seq sequence to skip an inclusive range between 1000 and 5000000',
+ $output
+ );
+ $this->assertStringContainsString('Number of customer records inserted is: 3', $output);
+ }
+
+ /**
+ * @depends testAlterSequence
+ */
+ public function testDropSequence()
+ {
+ $output = $this->runFunctionSnippet('pg_drop_sequence');
+ $this->assertStringContainsString(
+ 'Altered Customers table to drop DEFAULT from CustomerId ' .
+ 'column and dropped the Seq sequence',
+ $output
+ );
+ }
+
public static function tearDownAfterClass(): void
{
// Clean up
diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php
index 52b5aa8a9a..74b9d347a3 100644
--- a/spanner/test/spannerTest.php
+++ b/spanner/test/spannerTest.php
@@ -1048,6 +1048,46 @@ public function testReadWriteRetry()
$this->assertStringContainsString('Transaction complete.', $output);
}
+ /**
+ * @depends testCreateDatabase
+ */
+ public function testCreateSequence()
+ {
+ $output = $this->runFunctionSnippet('create_sequence');
+ $this->assertStringContainsString(
+ 'Created Seq sequence and Customers table, where ' .
+ 'the key column CustomerId uses the sequence as a default value',
+ $output
+ );
+ $this->assertStringContainsString('Number of customer records inserted is: 3', $output);
+ }
+
+ /**
+ * @depends testCreateSequence
+ */
+ public function testAlterSequence()
+ {
+ $output = $this->runFunctionSnippet('alter_sequence');
+ $this->assertStringContainsString(
+ 'Altered Seq sequence to skip an inclusive range between 1000 and 5000000',
+ $output
+ );
+ $this->assertStringContainsString('Number of customer records inserted is: 3', $output);
+ }
+
+ /**
+ * @depends testAlterSequence
+ */
+ public function testDropSequence()
+ {
+ $output = $this->runFunctionSnippet('drop_sequence');
+ $this->assertStringContainsString(
+ 'Altered Customers table to drop DEFAULT from CustomerId ' .
+ 'column and dropped the Seq sequence',
+ $output
+ );
+ }
+
private function testGetInstanceConfig()
{
$output = $this->runFunctionSnippet('get_instance_config', [
From ac4062aa1d2fb3844e4edcb4b29577a77bb051a5 Mon Sep 17 00:00:00 2001
From: Nicholas Cook
Date: Wed, 2 Aug 2023 16:44:20 -0700
Subject: [PATCH 061/285] feat(Transcoder): add batch mode sample and test
(#1892)
---
media/transcoder/composer.json | 2 +-
.../src/create_job_from_preset_batch_mode.php | 65 +++++++++++++++++++
media/transcoder/test/transcoderTest.php | 43 +++++++++---
3 files changed, 101 insertions(+), 9 deletions(-)
create mode 100644 media/transcoder/src/create_job_from_preset_batch_mode.php
diff --git a/media/transcoder/composer.json b/media/transcoder/composer.json
index 2183bb528e..9c8c5930db 100644
--- a/media/transcoder/composer.json
+++ b/media/transcoder/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/cloud-video-transcoder": "^0.8.2",
+ "google/cloud-video-transcoder": "^0.9.0",
"google/cloud-storage": "^1.9",
"ext-bcmath": "*"
}
diff --git a/media/transcoder/src/create_job_from_preset_batch_mode.php b/media/transcoder/src/create_job_from_preset_batch_mode.php
new file mode 100644
index 0000000000..7bced91cda
--- /dev/null
+++ b/media/transcoder/src/create_job_from_preset_batch_mode.php
@@ -0,0 +1,65 @@
+locationName($projectId, $location);
+ $job = new Job();
+ $job->setInputUri($inputUri);
+ $job->setOutputUri($outputUri);
+ $job->setTemplateId($preset);
+ $job->setMode(Job\ProcessingMode::PROCESSING_MODE_BATCH);
+ $job->setBatchModePriority(10);
+ $request = (new CreateJobRequest())
+ ->setParent($formattedParent)
+ ->setJob($job);
+
+ $response = $transcoderServiceClient->createJob($request);
+
+ // Print job name.
+ printf('Job: %s' . PHP_EOL, $response->getName());
+}
+# [END transcoder_create_job_from_preset_batch_mode]
+
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/transcoder/test/transcoderTest.php b/media/transcoder/test/transcoderTest.php
index 039858fcd4..24717849d4 100644
--- a/media/transcoder/test/transcoderTest.php
+++ b/media/transcoder/test/transcoderTest.php
@@ -47,6 +47,7 @@ class transcoderTest extends TestCase
private static $inputConcatVideo2Uri;
private static $inputOverlayUri;
private static $outputUriForPreset;
+ private static $outputUriForPresetBatchMode;
private static $outputUriForAdHoc;
private static $outputUriForTemplate;
private static $outputUriForAnimatedOverlay;
@@ -96,6 +97,7 @@ public static function setUpBeforeClass(): void
self::$inputConcatVideo2Uri = sprintf('gs://%s/%s', $bucketName, self::$testConcatVideo2FileName);
self::$inputOverlayUri = sprintf('gs://%s/%s', $bucketName, self::$testOverlayImageFileName);
self::$outputUriForPreset = sprintf('gs://%s/test-output-preset/', $bucketName);
+ self::$outputUriForPresetBatchMode = sprintf('gs://%s/test-output-preset-batch-mode/', $bucketName);
self::$outputUriForAdHoc = sprintf('gs://%s/test-output-adhoc/', $bucketName);
self::$outputUriForTemplate = sprintf('gs://%s/test-output-template/', $bucketName);
self::$outputUriForAnimatedOverlay = sprintf('gs://%s/test-output-animated-overlay/', $bucketName);
@@ -172,7 +174,7 @@ public function testJobFromAdHoc()
$jobId = explode('/', $createOutput);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
// Test Get method
@@ -214,7 +216,7 @@ public function testJobFromPreset()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -224,6 +226,31 @@ public function testJobFromPreset()
]);
}
+ public function testJobFromPresetBatchMode()
+ {
+ $output = $this->runFunctionSnippet('create_job_from_preset_batch_mode', [
+ self::$projectId,
+ self::$location,
+ self::$inputVideoUri,
+ self::$outputUriForPresetBatchMode,
+ self::$preset
+ ]);
+
+ $this->assertMatchesRegularExpression(sprintf('%s', self::$jobIdRegex), $output);
+
+ $jobId = explode('/', $output);
+ $jobId = trim($jobId[(count($jobId) - 1)]);
+
+ sleep(10);
+ $this->assertJobStateSucceeded($jobId);
+
+ $this->runFunctionSnippet('delete_job', [
+ self::$projectId,
+ self::$location,
+ $jobId
+ ]);
+ }
+
public function testJobFromTemplate()
{
$jobTemplateId = sprintf('php-test-template-%s', time());
@@ -246,7 +273,7 @@ public function testJobFromTemplate()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -277,7 +304,7 @@ public function testJobAnimatedOverlay()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -302,7 +329,7 @@ public function testJobStaticOverlay()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -326,7 +353,7 @@ public function testJobPeriodicImagesSpritesheet()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -350,7 +377,7 @@ public function testJobSetNumberImagesSpritesheet()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
@@ -379,7 +406,7 @@ public function testJobConcat()
$jobId = explode('/', $output);
$jobId = trim($jobId[(count($jobId) - 1)]);
- sleep(30);
+ sleep(10);
$this->assertJobStateSucceeded($jobId);
$this->runFunctionSnippet('delete_job', [
From bc962f5b52c4f97b49ed0926c35723f8f0157bd6 Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Tue, 15 Aug 2023 15:02:41 +0200
Subject: [PATCH 062/285] fix(deps): update dependency
google/cloud-error-reporting to ^0.21.0 (#1908)
---
error_reporting/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/error_reporting/composer.json b/error_reporting/composer.json
index 7bedb46b9a..7cc049c1fe 100644
--- a/error_reporting/composer.json
+++ b/error_reporting/composer.json
@@ -1,5 +1,5 @@
{
"require": {
- "google/cloud-error-reporting": "^0.20.2"
+ "google/cloud-error-reporting": "^0.21.0"
}
}
From ad2b877cd02f065be4498b0315d079f205941aba Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Tue, 15 Aug 2023 15:03:00 +0200
Subject: [PATCH 063/285] fix(deps): update dependency
google/cloud-error-reporting to ^0.21.0 (#1907)
---
appengine/standard/errorreporting/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/appengine/standard/errorreporting/composer.json b/appengine/standard/errorreporting/composer.json
index 3ae499d7ff..e0a12eebb1 100644
--- a/appengine/standard/errorreporting/composer.json
+++ b/appengine/standard/errorreporting/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/cloud-error-reporting": "^0.20.0"
+ "google/cloud-error-reporting": "^0.21.0"
},
"autoload": {
"files": [
From 16f7498c2faba06a0a5c4fda4587ed5a74493830 Mon Sep 17 00:00:00 2001
From: Nicholas Cook
Date: Tue, 15 Aug 2023 06:04:18 -0700
Subject: [PATCH 064/285] feat(LiveStream): add samples and tests for assets
and pools (#1909)
---
media/livestream/composer.json | 2 +-
media/livestream/src/create_asset.php | 75 ++++++++++++++
media/livestream/src/delete_asset.php | 64 ++++++++++++
media/livestream/src/get_asset.php | 58 +++++++++++
media/livestream/src/get_pool.php | 58 +++++++++++
media/livestream/src/list_assets.php | 59 +++++++++++
media/livestream/src/update_pool.php | 81 +++++++++++++++
media/livestream/test/livestreamTest.php | 122 +++++++++++++++++++++++
8 files changed, 518 insertions(+), 1 deletion(-)
create mode 100644 media/livestream/src/create_asset.php
create mode 100644 media/livestream/src/delete_asset.php
create mode 100644 media/livestream/src/get_asset.php
create mode 100644 media/livestream/src/get_pool.php
create mode 100644 media/livestream/src/list_assets.php
create mode 100644 media/livestream/src/update_pool.php
diff --git a/media/livestream/composer.json b/media/livestream/composer.json
index 6946109888..ab584de13d 100644
--- a/media/livestream/composer.json
+++ b/media/livestream/composer.json
@@ -2,6 +2,6 @@
"name": "google/live-stream-sample",
"type": "project",
"require": {
- "google/cloud-video-live-stream": "^0.5.0"
+ "google/cloud-video-live-stream": "^0.6.0"
}
}
diff --git a/media/livestream/src/create_asset.php b/media/livestream/src/create_asset.php
new file mode 100644
index 0000000000..d88c0506bb
--- /dev/null
+++ b/media/livestream/src/create_asset.php
@@ -0,0 +1,75 @@
+locationName($callingProjectId, $location);
+ $asset = (new Asset())
+ ->setVideo(
+ (new Asset\VideoAsset())
+ ->setUri($assetUri));
+
+ // Run the asset creation request. The response is a long-running operation ID.
+ $request = (new CreateAssetRequest())
+ ->setParent($parent)
+ ->setAsset($asset)
+ ->setAssetId($assetId);
+ $operationResponse = $livestreamClient->createAsset($request);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Asset: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
+}
+// [END livestream_create_asset]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/src/delete_asset.php b/media/livestream/src/delete_asset.php
new file mode 100644
index 0000000000..a93648db90
--- /dev/null
+++ b/media/livestream/src/delete_asset.php
@@ -0,0 +1,64 @@
+assetName($callingProjectId, $location, $assetId);
+
+ // Run the asset deletion request. The response is a long-running operation ID.
+ $request = (new DeleteAssetRequest())
+ ->setName($formattedName);
+ $operationResponse = $livestreamClient->deleteAsset($request);
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ // Print status
+ printf('Deleted asset %s' . PHP_EOL, $assetId);
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
+}
+// [END livestream_delete_asset]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/src/get_asset.php b/media/livestream/src/get_asset.php
new file mode 100644
index 0000000000..c37a78dab1
--- /dev/null
+++ b/media/livestream/src/get_asset.php
@@ -0,0 +1,58 @@
+assetName($callingProjectId, $location, $assetId);
+
+ // Get the asset.
+ $request = (new GetAssetRequest())
+ ->setName($formattedName);
+ $response = $livestreamClient->getAsset($request);
+ // Print results
+ printf('Asset: %s' . PHP_EOL, $response->getName());
+}
+// [END livestream_get_asset]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/src/get_pool.php b/media/livestream/src/get_pool.php
new file mode 100644
index 0000000000..72f5401038
--- /dev/null
+++ b/media/livestream/src/get_pool.php
@@ -0,0 +1,58 @@
+poolName($callingProjectId, $location, $poolId);
+
+ // Get the pool.
+ $request = (new GetPoolRequest())
+ ->setName($formattedName);
+ $response = $livestreamClient->getPool($request);
+ // Print results
+ printf('Pool: %s' . PHP_EOL, $response->getName());
+}
+// [END livestream_get_pool]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/src/list_assets.php b/media/livestream/src/list_assets.php
new file mode 100644
index 0000000000..2bfc2f9709
--- /dev/null
+++ b/media/livestream/src/list_assets.php
@@ -0,0 +1,59 @@
+locationName($callingProjectId, $location);
+ $request = (new ListAssetsRequest())
+ ->setParent($parent);
+
+ $response = $livestreamClient->listAssets($request);
+ // Print the asset list.
+ $assets = $response->iterateAllElements();
+ print('Assets:' . PHP_EOL);
+ foreach ($assets as $asset) {
+ printf('%s' . PHP_EOL, $asset->getName());
+ }
+}
+// [END livestream_list_assets]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/src/update_pool.php b/media/livestream/src/update_pool.php
new file mode 100644
index 0000000000..2f6636ed8b
--- /dev/null
+++ b/media/livestream/src/update_pool.php
@@ -0,0 +1,81 @@
+poolName($callingProjectId, $location, $poolId);
+ $pool = (new Pool())
+ ->setName($formattedName)
+ ->setNetworkConfig(
+ (new Pool\NetworkConfig())
+ ->setPeeredNetwork($peeredNetwork));
+
+ $updateMask = new FieldMask([
+ 'paths' => ['network_config']
+ ]);
+
+ // Run the pool update request. The response is a long-running operation ID.
+ $request = (new UpdatePoolRequest())
+ ->setPool($pool)
+ ->setUpdateMask($updateMask);
+ $operationResponse = $livestreamClient->updatePool($request);
+
+ $operationResponse->pollUntilComplete();
+ if ($operationResponse->operationSucceeded()) {
+ $result = $operationResponse->getResult();
+ // Print results
+ printf('Updated pool: %s' . PHP_EOL, $result->getName());
+ } else {
+ $error = $operationResponse->getError();
+ // handleError($error)
+ }
+}
+// [END livestream_update_pool]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/media/livestream/test/livestreamTest.php b/media/livestream/test/livestreamTest.php
index a7dc2da675..3976ffb0ef 100644
--- a/media/livestream/test/livestreamTest.php
+++ b/media/livestream/test/livestreamTest.php
@@ -50,6 +50,14 @@ class livestreamTest extends TestCase
private static $eventId;
private static $eventName;
+ private static $assetIdPrefix = 'php-test-asset';
+ private static $assetId;
+ private static $assetName;
+ private static $assetUri = 'gs://cloud-samples-data/media/ForBiggerEscapes.mp4';
+
+ private static $poolId;
+ private static $poolName;
+
public static function setUpBeforeClass(): void
{
self::checkProjectEnvVars();
@@ -57,6 +65,7 @@ public static function setUpBeforeClass(): void
self::deleteOldChannels();
self::deleteOldInputs();
+ self::deleteOldAssets();
}
public function testCreateInput()
@@ -384,6 +393,93 @@ public function testDeleteChannelWithEvents()
]);
}
+ /** @depends testDeleteChannelWithEvents */
+ public function testCreateAsset()
+ {
+ self::$assetId = sprintf('%s-%s-%s', self::$assetIdPrefix, uniqid(), time());
+ self::$assetName = sprintf('projects/%s/locations/%s/assets/%s', self::$projectId, self::$location, self::$assetId);
+
+ $output = $this->runFunctionSnippet('create_asset', [
+ self::$projectId,
+ self::$location,
+ self::$assetId,
+ self::$assetUri
+ ]);
+ $this->assertStringContainsString(self::$assetName, $output);
+ }
+
+ /** @depends testCreateAsset */
+ public function testListAssets()
+ {
+ $output = $this->runFunctionSnippet('list_assets', [
+ self::$projectId,
+ self::$location
+ ]);
+ $this->assertStringContainsString(self::$assetName, $output);
+ }
+
+ /** @depends testListAssets */
+ public function testGetAsset()
+ {
+ $output = $this->runFunctionSnippet('get_asset', [
+ self::$projectId,
+ self::$location,
+ self::$assetId
+ ]);
+ $this->assertStringContainsString(self::$assetName, $output);
+ }
+
+ /** @depends testGetAsset */
+ public function testDeleteAsset()
+ {
+ $output = $this->runFunctionSnippet('delete_asset', [
+ self::$projectId,
+ self::$location,
+ self::$assetId
+ ]);
+ $this->assertStringContainsString('Deleted asset', $output);
+ }
+
+ /** @depends testDeleteAsset */
+ public function testGetPool()
+ {
+ self::$poolId = 'default'; # only 1 pool supported per location
+ self::$poolName = sprintf('projects/%s/locations/%s/pools/%s', self::$projectId, self::$location, self::$poolId);
+
+ $output = $this->runFunctionSnippet('get_pool', [
+ self::$projectId,
+ self::$location,
+ self::$poolId
+ ]);
+ $this->assertStringContainsString(self::$poolName, $output);
+ }
+
+ /** @depends testGetPool */
+ public function testUpdatePool()
+ {
+ # You can't update a pool if any channels are running. Updating a pool
+ # takes a long time to complete. If tests are running in parallel for
+ # different versions of PHP, this test will fail.
+ $this->markTestSkipped('Cannot be run if tests run in parallel.');
+
+ $output = $this->runFunctionSnippet('update_pool', [
+ self::$projectId,
+ self::$location,
+ self::$poolId,
+ ''
+ ]);
+ $this->assertStringContainsString(self::$poolName, $output);
+
+ $livestreamClient = new LivestreamServiceClient();
+ $formattedName = $livestreamClient->poolName(
+ self::$projectId,
+ self::$location,
+ self::$poolId
+ );
+ $pool = $livestreamClient->getPool($formattedName);
+ $this->assertEquals($pool->getNetworkConfig()->getPeeredNetwork(), '');
+ }
+
private static function deleteOldInputs(): void
{
$livestreamClient = new LivestreamServiceClient();
@@ -468,4 +564,30 @@ private static function deleteOldChannels(): void
}
}
}
+
+ private static function deleteOldAssets(): void
+ {
+ $livestreamClient = new LivestreamServiceClient();
+ $parent = $livestreamClient->locationName(self::$projectId, self::$location);
+ $response = $livestreamClient->listAssets($parent);
+ $assets = $response->iterateAllElements();
+
+ $currentTime = time();
+ $oneHourInSecs = 60 * 60 * 1;
+
+ foreach ($assets as $asset) {
+ $tmp = explode('/', $asset->getName());
+ $id = end($tmp);
+ $tmp = explode('-', $id);
+ $timestamp = intval(end($tmp));
+
+ if ($currentTime - $timestamp >= $oneHourInSecs) {
+ try {
+ $livestreamClient->deleteAsset($asset->getName());
+ } catch (ApiException $e) {
+ printf('Asset delete failed: %s.' . PHP_EOL, $e->getMessage());
+ }
+ }
+ }
+ }
}
From 286373142f96d347c7052af58ebd6a1f8e4ef41b Mon Sep 17 00:00:00 2001
From: Gareth
Date: Tue, 22 Aug 2023 13:12:56 -0700
Subject: [PATCH 065/285] feat(functions): samples for typed function signature
(#1866)
---
functions/typed_greeting/composer.json | 12 ++++
functions/typed_greeting/index.php | 84 ++++++++++++++++++++++
functions/typed_greeting/phpunit.xml.dist | 35 +++++++++
functions/typed_greeting/test/UnitTest.php | 67 +++++++++++++++++
4 files changed, 198 insertions(+)
create mode 100644 functions/typed_greeting/composer.json
create mode 100644 functions/typed_greeting/index.php
create mode 100644 functions/typed_greeting/phpunit.xml.dist
create mode 100644 functions/typed_greeting/test/UnitTest.php
diff --git a/functions/typed_greeting/composer.json b/functions/typed_greeting/composer.json
new file mode 100644
index 0000000000..6655c8e40e
--- /dev/null
+++ b/functions/typed_greeting/composer.json
@@ -0,0 +1,12 @@
+{
+ "require": {
+ "php": ">= 7.4",
+ "google/cloud-functions-framework": "^1.3"
+ },
+ "scripts": {
+ "start": [
+ "Composer\\Config::disableProcessTimeout",
+ "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
+ ]
+ }
+}
diff --git a/functions/typed_greeting/index.php b/functions/typed_greeting/index.php
new file mode 100644
index 0000000000..3a3b4d8426
--- /dev/null
+++ b/functions/typed_greeting/index.php
@@ -0,0 +1,84 @@
+first_name = $first_name;
+ $this->last_name = $last_name;
+ }
+
+ public function serializeToJsonString(): string
+ {
+ return json_encode([
+ 'first_name' => $this->first_name,
+ 'last_name' => $this->last_name,
+ ]);
+ }
+
+ public function mergeFromJsonString(string $body): void
+ {
+ $obj = json_decode($body);
+ $this->first_name = $obj['first_name'];
+ $this->last_name = $obj['last_name'];
+ }
+}
+
+class GreetingResponse
+{
+ /** @var string */
+ public $message;
+
+ public function __construct(string $message = '')
+ {
+ $this->message = $message;
+ }
+
+ public function serializeToJsonString(): string
+ {
+ return json_encode([
+ 'message' => $message,
+ ]);
+ }
+
+ public function mergeFromJsonString(string $body): void
+ {
+ $obj = json_decode($body);
+ $this->message = $obj['message'];
+ }
+};
+
+function greeting(GreetingRequest $req): GreetingResponse
+{
+ return new GreetingResponse("Hello $req->first_name $req->last_name!");
+};
+
+FunctionsFramework::typed('greeting', 'greeting');
+
+// [END functions_typed_greeting]
diff --git a/functions/typed_greeting/phpunit.xml.dist b/functions/typed_greeting/phpunit.xml.dist
new file mode 100644
index 0000000000..1a192330ff
--- /dev/null
+++ b/functions/typed_greeting/phpunit.xml.dist
@@ -0,0 +1,35 @@
+
+
+
+
+
+ .
+ vendor
+
+
+
+
+
+
+
+ .
+
+ ./vendor
+
+
+
+
diff --git a/functions/typed_greeting/test/UnitTest.php b/functions/typed_greeting/test/UnitTest.php
new file mode 100644
index 0000000000..5aa0d2f6e5
--- /dev/null
+++ b/functions/typed_greeting/test/UnitTest.php
@@ -0,0 +1,67 @@
+runFunction(self::$entryPoint, [new GreetingRequest($first_name, $last_name)]);
+ $this->assertEquals($expected_message, $actual->message, $label . ':');
+ }
+
+ private static function runFunction($functionName, array $params = []): GreetingResponse
+ {
+ return call_user_func_array($functionName, $params);
+ }
+
+ public static function cases(): array
+ {
+ return [
+ [
+ 'label' => 'Default',
+ 'first_name' => 'Jane',
+ 'last_name' => 'Doe',
+ 'expected_message' => 'Hello Jane Doe!',
+ ],
+ ];
+ }
+}
From 3438bdb407efb3a67e52b8d190e73d0f1fb6a7cc Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 23 Aug 2023 12:54:04 +0530
Subject: [PATCH 066/285] feat(dlp): sample for Hybrid Job Trigger ,
kAnonymity with entity id , and DeIdentify Replace InfoType (#1900)
---
dlp/src/deidentify_replace_infotype.php | 100 ++++++++
dlp/src/inspect_gcs.php | 9 +-
...nspect_send_data_to_hybrid_job_trigger.php | 136 ++++++++++
dlp/src/k_anonymity_with_entity_id.php | 172 +++++++++++++
dlp/test/dlpLongRunningTest.php | 121 ++++++++-
dlp/test/dlpTest.php | 241 ++++++++++++++++++
6 files changed, 764 insertions(+), 15 deletions(-)
create mode 100644 dlp/src/deidentify_replace_infotype.php
create mode 100644 dlp/src/inspect_send_data_to_hybrid_job_trigger.php
create mode 100644 dlp/src/k_anonymity_with_entity_id.php
diff --git a/dlp/src/deidentify_replace_infotype.php b/dlp/src/deidentify_replace_infotype.php
new file mode 100644
index 0000000000..46eb2d530c
--- /dev/null
+++ b/dlp/src/deidentify_replace_infotype.php
@@ -0,0 +1,100 @@
+setValue($string);
+
+ // The infoTypes of information to mask.
+ $phoneNumberinfoType = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $personNameinfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+ $infoTypes = [$phoneNumberinfoType, $personNameinfoType];
+
+ // Create the configuration object.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes);
+
+ // Create the information transform configuration objects.
+ $primitiveTransformation = (new PrimitiveTransformation())
+ ->setReplaceWithInfoTypeConfig(new ReplaceWithInfoTypeConfig());
+
+ $infoTypeTransformation = (new InfoTypeTransformation())
+ ->setPrimitiveTransformation($primitiveTransformation);
+
+ $infoTypeTransformations = (new InfoTypeTransformations())
+ ->setTransformations([$infoTypeTransformation]);
+
+ // Create the deidentification configuration object.
+ $deidentifyConfig = (new DeidentifyConfig())
+ ->setInfoTypeTransformations($infoTypeTransformations);
+
+ // Run request.
+ $response = $dlp->deidentifyContent([
+ 'parent' => $parent,
+ 'deidentifyConfig' => $deidentifyConfig,
+ 'item' => $content,
+ 'inspectConfig' => $inspectConfig
+ ]);
+
+ // Print the results.
+ printf('Text after replace with infotype config: %s', $response->getItem()->getValue());
+}
+# [END dlp_deidentify_replace_infotype]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_gcs.php b/dlp/src/inspect_gcs.php
index 996199546c..59930d8e32 100644
--- a/dlp/src/inspect_gcs.php
+++ b/dlp/src/inspect_gcs.php
@@ -1,5 +1,4 @@
$callingProjectId,
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId,
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// The infoTypes of information to match
diff --git a/dlp/src/inspect_send_data_to_hybrid_job_trigger.php b/dlp/src/inspect_send_data_to_hybrid_job_trigger.php
new file mode 100644
index 0000000000..6cec8978de
--- /dev/null
+++ b/dlp/src/inspect_send_data_to_hybrid_job_trigger.php
@@ -0,0 +1,136 @@
+setValue($string);
+
+ $container = (new Container())
+ ->setFullPath('10.0.0.2:logs1:app1')
+ ->setRelativePath('app1')
+ ->setRootPath('10.0.0.2:logs1')
+ ->setType('logging_sys')
+ ->setVersion('1.2');
+
+ $findingDetails = (new HybridFindingDetails())
+ ->setContainerDetails($container)
+ ->setLabels([
+ 'env' => 'prod',
+ 'appointment-bookings-comments' => ''
+ ]);
+
+ $hybridItem = (new HybridContentItem())
+ ->setItem($content)
+ ->setFindingDetails($findingDetails);
+
+ $parent = "projects/$callingProjectId/locations/global";
+ $name = "projects/$callingProjectId/locations/global/jobTriggers/" . $jobTriggerId;
+
+ $triggerJob = null;
+ try {
+ $triggerJob = $dlp->activateJobTrigger($name);
+ } catch (\InvalidArgumentException $e) {
+ $result = $dlp->listDlpJobs($parent, ['filter' => 'trigger_name=' . $name]);
+ foreach ($result as $job) {
+ $triggerJob = $job;
+ }
+ }
+
+ $dlp->hybridInspectJobTrigger($name, [
+ 'hybridItem' => $hybridItem,
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(10);
+ $job = $dlp->getDlpJob($triggerJob->getName());
+ if ($job->getState() != JobState::RUNNING) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_send_data_to_hybrid_job_trigger]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/k_anonymity_with_entity_id.php b/dlp/src/k_anonymity_with_entity_id.php
new file mode 100644
index 0000000000..dd481a41be
--- /dev/null
+++ b/dlp/src/k_anonymity_with_entity_id.php
@@ -0,0 +1,172 @@
+setProjectId($callingProjectId)
+ ->setDatasetId($datasetId)
+ ->setTableId($tableId);
+
+ // Create a list of FieldId objects based on the provided list of column names.
+ $quasiIds = array_map(
+ function ($id) {
+ return (new FieldId())
+ ->setName($id);
+ },
+ $quasiIdNames
+ );
+
+ // Specify the unique identifier in the source table for the k-anonymity analysis.
+ $statsConfig = (new KAnonymityConfig())
+ ->setEntityId((new EntityId())
+ ->setField((new FieldId())
+ ->setName('Name')))
+ ->setQuasiIds($quasiIds);
+
+ // Configure the privacy metric to compute for re-identification risk analysis.
+ $privacyMetric = (new PrivacyMetric())
+ ->setKAnonymityConfig($statsConfig);
+
+ // Specify the bigquery table to store the findings.
+ // The "test_results" table in the given BigQuery dataset will be created if it doesn't
+ // already exist.
+ $outBigqueryTable = (new BigQueryTable())
+ ->setProjectId($callingProjectId)
+ ->setDatasetId($datasetId)
+ ->setTableId('test_results');
+
+ $outputStorageConfig = (new OutputStorageConfig())
+ ->setTable($outBigqueryTable);
+
+ $findings = (new SaveFindings())
+ ->setOutputConfig($outputStorageConfig);
+
+ $action = (new Action())
+ ->setSaveFindings($findings);
+
+ // Construct risk analysis job config to run.
+ $riskJob = (new RiskAnalysisJobConfig())
+ ->setPrivacyMetric($privacyMetric)
+ ->setSourceTable($bigqueryTable)
+ ->setActions([$action]);
+
+ // Submit request.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'riskJob' => $riskJob
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(10);
+ $job = $dlp->getDlpJob($job->getName());
+ if ($job->getState() == JobState::DONE) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $histBuckets = $job->getRiskDetails()->getKAnonymityResult()->getEquivalenceClassHistogramBuckets();
+
+ foreach ($histBuckets as $bucketIndex => $histBucket) {
+ // Print bucket stats.
+ printf('Bucket %s:' . PHP_EOL, $bucketIndex);
+ printf(
+ ' Bucket size range: [%s, %s]' . PHP_EOL,
+ $histBucket->getEquivalenceClassSizeLowerBound(),
+ $histBucket->getEquivalenceClassSizeUpperBound()
+ );
+
+ // Print bucket values.
+ foreach ($histBucket->getBucketValues() as $percent => $valueBucket) {
+ // Pretty-print quasi-ID values.
+ printf(' Quasi-ID values:' . PHP_EOL);
+ foreach ($valueBucket->getQuasiIdsValues() as $index => $value) {
+ print(' ' . $value->serializeToJsonString() . PHP_EOL);
+ }
+ printf(
+ ' Class size: %s' . PHP_EOL,
+ $valueBucket->getEquivalenceClassSize()
+ );
+ }
+ }
+
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_k_anonymity_with_entity_id]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpLongRunningTest.php b/dlp/test/dlpLongRunningTest.php
index b2491b3a09..81ea7527ae 100644
--- a/dlp/test/dlpLongRunningTest.php
+++ b/dlp/test/dlpLongRunningTest.php
@@ -15,11 +15,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
namespace Google\Cloud\Samples\Dlp;
+use Google\Cloud\Dlp\V2\DlpJob;
+use Google\Cloud\Dlp\V2\DlpJob\JobState;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Google\Cloud\Dlp\V2\DlpServiceClient;
+use Google\Cloud\Dlp\V2\InfoType;
+use Google\Cloud\Dlp\V2\InfoTypeStats;
+use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
+use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
+use Google\Cloud\PubSub\Message;
use Google\Cloud\PubSub\PubSubClient;
+use Google\Cloud\PubSub\Subscription;
+use Google\Cloud\PubSub\Topic;
/**
* Unit Tests for dlp commands.
@@ -27,6 +40,7 @@
class dlpLongRunningTest extends TestCase
{
use TestTrait;
+ use ProphecyTrait;
private static $dataset = 'integration_tests_dlp';
private static $table = 'harmful';
@@ -82,15 +96,106 @@ public function testInspectGCS()
{
$bucketName = $this->requireEnv('GOOGLE_STORAGE_BUCKET');
$objectName = 'dlp/harmful.csv';
+ $topicId = self::$topic->name();
+ $subscriptionId = self::$subscription->name();
- $output = $this->runFunctionSnippet('inspect_gcs', [
- self::$projectId,
- self::$topic->name(),
- self::$subscription->name(),
- $bucketName,
- $objectName,
- ]);
- $this->assertStringContainsString('PERSON_NAME', $output);
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
+ ->setState(JobState::DONE)
+ ->setInspectDetails((new InspectDataSourceDetails())
+ ->setResult((new Result())
+ ->setInfoTypeStats([
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('PERSON_NAME'))
+ ->setCount(3),
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('CREDIT_CARD_NUMBER'))
+ ->setCount(3)
+ ])));
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic($topicId)
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . $topicId);
+
+ $topicMock->subscription($subscriptionId)
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/job-name-123']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $sampleFile = __DIR__ . '/../src/inspect_gcs.php';
+ $tmpFileName = basename($sampleFile, '.php') . '_temp';
+ $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements = [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ 'inspect_gcs' => $tmpFileName
+ ];
+ $fileContent = strtr($fileContent, $replacements);
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent
+ );
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Call the method under test
+ $output = $this->runFunctionSnippet($tmpFileName, [
+ self::$projectId,
+ $topicId,
+ $subscriptionId,
+ $bucketName,
+ $objectName,
+ ]);
+
+ // delete topic , subscription , and temp file
+ unlink($tmpFilePath);
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ $this->assertStringContainsString('infoType CREDIT_CARD_NUMBER', $output);
}
public function testNumericalStats()
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 36e0bca185..38c4d63318 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -30,6 +30,20 @@
use Google\Cloud\Dlp\V2\InfoTypeStats;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult\KAnonymityEquivalenceClass;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult\KAnonymityHistogramBucket;
+use Google\Cloud\Dlp\V2\Value;
+use Google\Cloud\Dlp\V2\HybridInspectResponse;
+use Google\Cloud\Dlp\V2\HybridOptions;
+use Google\Cloud\Dlp\V2\InspectConfig;
+use Google\Cloud\Dlp\V2\InspectJobConfig;
+use Google\Cloud\Dlp\V2\JobTrigger;
+use Google\Cloud\Dlp\V2\JobTrigger\Status;
+use Google\Cloud\Dlp\V2\JobTrigger\Trigger;
+use Google\Cloud\Dlp\V2\Manual;
+use Google\Cloud\Dlp\V2\StorageConfig;
/**
* Unit Tests for dlp commands.
@@ -1082,4 +1096,231 @@ public function testDeidentifyCloudStorage()
$this->assertStringContainsString('infoType PERSON_NAME', $output);
$this->assertStringContainsString('infoType EMAIL_ADDRESS', $output);
}
+
+ public function testDeidentifyReplaceInfotype()
+ {
+ $inputString = 'Please call Steve Smith. His number is (555) 253-0000.';
+ $output = $this->runFunctionSnippet('deidentify_replace_infotype', [
+ self::$projectId,
+ $inputString
+ ]);
+ $this->assertStringContainsString('[PHONE_NUMBER]', $output);
+ $this->assertStringContainsString('[PERSON_NAME]', $output);
+ }
+
+ public function testKAnonymityWithEntityId()
+ {
+ $datasetId = $this->requireEnv('DLP_DATASET_ID');
+ $tableId = $this->requireEnv('DLP_TABLE_ID');
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setKAnonymityResult((new KAnonymityResult())
+ ->setEquivalenceClassHistogramBuckets([(new KAnonymityHistogramBucket())
+ ->setEquivalenceClassSizeLowerBound(1)
+ ->setEquivalenceClassSizeUpperBound(1)
+ ->setBucketValues([
+ (new KAnonymityEquivalenceClass())
+ ->setQuasiIdsValues([(new Value())
+ ->setStringValue('{"stringValue":"[\"19\",\"8291 3627 8250 1234\"]"}')])
+ ->setEquivalenceClassSize(1),
+ (new KAnonymityEquivalenceClass())
+ ->setQuasiIdsValues([(new Value())
+ ->setStringValue('{"stringValue":"[\"27\",\"4231 5555 6781 9876\"]"}')])
+ ->setEquivalenceClassSize(1)
+
+ ])])
+ )
+ );
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ // Creating a temp file for testing.
+ $sampleFile = __DIR__ . '/../src/k_anonymity_with_entity_id.php';
+ $tmpFileName = basename($sampleFile, '.php') . '_temp';
+ $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements = [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ 'k_anonymity_with_entity_id' => $tmpFileName
+ ];
+ $fileContent = strtr($fileContent, $replacements);
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent,
+ );
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ // Call the method under test
+ $output = $this->runFunctionSnippet($tmpFileName, [
+ self::$projectId,
+ $datasetId,
+ $tableId,
+ ['Age', 'Mystery']
+ ]);
+ // delete temp file
+ unlink($tmpFilePath);
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
+ $this->assertStringContainsString('Bucket size range: [1, 1]', $output);
+ }
+
+ public function create_hybrid_job_trigger(
+ string $triggerId,
+ string $displayName,
+ string $description
+ ): string {
+ // Instantiate a client.
+ $dlp = new DlpServiceClient();
+
+ // Create the inspectConfig object.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes([
+ (new InfoType())
+ ->setName('PERSON_NAME'),
+ (new InfoType())
+ ->setName('PHONE_NUMBER')
+ ])
+ ->setIncludeQuote(true);
+
+ $storageConfig = (new StorageConfig())
+ ->setHybridOptions((new HybridOptions())
+ ->setRequiredFindingLabelKeys(
+ ['appointment-bookings-comments']
+ )
+ ->setLabels([
+ 'env' => 'prod'
+ ]));
+
+ // Construct the insJobConfig object.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig);
+
+ // Create triggers
+ $triggerObject = (new Trigger())
+ ->setManual(new Manual());
+
+ // ----- Construct trigger object -----
+ $jobTriggerObject = (new JobTrigger())
+ ->setTriggers([$triggerObject])
+ ->setInspectJob($inspectJobConfig)
+ ->setStatus(Status::HEALTHY)
+ ->setDisplayName($displayName)
+ ->setDescription($description);
+
+ // Run trigger creation request
+ $parent = 'projects/' . self::$projectId . '/locations/global';
+ $trigger = $dlp->createJobTrigger($parent, $jobTriggerObject, [
+ 'triggerId' => $triggerId
+ ]);
+
+ return $trigger->getName();
+ }
+
+ public function testInspectSendDataToHybridJobTrigger()
+ {
+ $displayName = uniqid('My trigger display name ');
+ $description = uniqid('My trigger description ');
+ $triggerId = uniqid('my-php-test-trigger-');
+ $string = 'My email is test@example.org';
+
+ $fullTriggerId = $this->create_hybrid_job_trigger(
+ $triggerId,
+ $displayName,
+ $description
+ );
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setInspectDetails((new InspectDataSourceDetails())
+ ->setResult((new Result())
+ ->setInfoTypeStats([
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('PERSON_NAME'))
+ ->setCount(13),
+ (new InfoTypeStats())
+ ->setInfoType((new InfoType())->setName('PHONE_NUMBER'))
+ ->setCount(5)
+ ])));
+
+ $dlpServiceClientMock
+ ->activateJobTrigger($fullTriggerId)
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $dlpServiceClientMock
+ ->listDlpJobs(Argument::any(), Argument::type('array'))
+ ->willReturn([$getDlpJobResponse]);
+
+ $dlpServiceClientMock
+ ->hybridInspectJobTrigger(Argument::any(), Argument::type('array'))
+ ->shouldBeCalledTimes(1)
+ ->willReturn(new HybridInspectResponse());
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ // Creating a temp file for testing.
+ $sampleFile = __DIR__ . '/../src/inspect_send_data_to_hybrid_job_trigger.php';
+ $tmpFileName = basename($sampleFile, '.php') . '_temp';
+ $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements = [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ 'inspect_send_data_to_hybrid_job_trigger' => $tmpFileName
+ ];
+ $fileContent = strtr($fileContent, $replacements);
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent
+ );
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ $output = $this->runFunctionSnippet($tmpFileName, [
+ self::$projectId,
+ $triggerId,
+ $string
+ ]);
+
+ // delete a temp file.
+ unlink($tmpFilePath);
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ $this->assertStringContainsString('infoType PHONE_NUMBER', $output);
+
+ $output = $this->runFunctionSnippet('delete_trigger', [
+ self::$projectId,
+ $triggerId
+ ]);
+ $this->assertStringContainsString('Successfully deleted trigger ' . $fullTriggerId, $output);
+ }
}
From c4da9944c604ddb3bfc6f31eb5bebef4bd7c8fc2 Mon Sep 17 00:00:00 2001
From: Patti Shin
Date: Thu, 24 Aug 2023 18:25:48 -0700
Subject: [PATCH 067/285] feat: initial commit of run mc php nginx sample
(#1901)
* feat: initial commit of run mc php nginx sample
* chore: upgrade texttospeech samples to new surface (#1880)
* Revert "chore: upgrade texttospeech samples to new surface (#1880)" (#1902)
This reverts commit 18c687234b2c72b57ea7503fb4806df701308e26.
* test: update php mc test and check deployment logs
* test: updating test and clean up
* chore: clean up
* refactor: rename test
* Update run/multi-container/hello-php-nginx-sample/nginx/nginx.conf
Co-authored-by: Julien Breux
* Update run/multi-container/hello-php-nginx-sample/Makefile
Co-authored-by: Julien Breux
* fix: flip container deps
* Update run/multi-container/hello-php-nginx-sample/php-app/Dockerfile
Co-authored-by: Adam Ross
* Update run/multi-container/hello-php-nginx-sample/php-app/opcache.ini
Co-authored-by: Adam Ross
* Update run/multi-container/hello-php-nginx-sample/README.md
Co-authored-by: Adam Ross
* refactor: updating with suggestions (updating readme, Cloud Run memory limit updates, rm makefile, add composer)
* fix: resolve snippet-bot failures about lack of product name
* refactor: update .ini and readme with concurrency/memory info
* chore: clean up readme
* refactor: updating comment about dockerfile context
---------
Co-authored-by: Brent Shaffer
Co-authored-by: Yash Sahu <54198301+yash30201@users.noreply.github.com>
Co-authored-by: Julien Breux
Co-authored-by: Adam Ross
---
run/README.md | 2 +
.../hello-php-nginx-sample/README.md | 81 +++++++
.../hello-php-nginx-sample/composer.json | 5 +
.../hello-php-nginx-sample/nginx/Dockerfile | 28 +++
.../hello-php-nginx-sample/nginx/index.php | 19 ++
.../hello-php-nginx-sample/nginx/nginx.conf | 49 +++++
.../hello-php-nginx-sample/php-app/Dockerfile | 35 ++++
.../hello-php-nginx-sample/php-app/index.php | 22 ++
.../php-app/opcache.ini | 11 +
.../hello-php-nginx-sample/phpunit.xml.dist | 36 ++++
.../hello-php-nginx-sample/service.yaml | 59 ++++++
.../hello-php-nginx-sample/test/TestCase.php | 198 ++++++++++++++++++
12 files changed, 545 insertions(+)
create mode 100644 run/multi-container/hello-php-nginx-sample/README.md
create mode 100644 run/multi-container/hello-php-nginx-sample/composer.json
create mode 100644 run/multi-container/hello-php-nginx-sample/nginx/Dockerfile
create mode 100644 run/multi-container/hello-php-nginx-sample/nginx/index.php
create mode 100644 run/multi-container/hello-php-nginx-sample/nginx/nginx.conf
create mode 100644 run/multi-container/hello-php-nginx-sample/php-app/Dockerfile
create mode 100644 run/multi-container/hello-php-nginx-sample/php-app/index.php
create mode 100644 run/multi-container/hello-php-nginx-sample/php-app/opcache.ini
create mode 100644 run/multi-container/hello-php-nginx-sample/phpunit.xml.dist
create mode 100644 run/multi-container/hello-php-nginx-sample/service.yaml
create mode 100644 run/multi-container/hello-php-nginx-sample/test/TestCase.php
diff --git a/run/README.md b/run/README.md
index 1fb9a51837..ed7e5fea4d 100644
--- a/run/README.md
+++ b/run/README.md
@@ -10,6 +10,7 @@
| --------------------------------------- | ------------------------ | ------------- |
|[Hello World][helloworld] | Quickstart | [
][run_button_helloworld] |
|[Laravel][laravel] | Deploy Laravel on Cloud Run | -|
+|[Multi-container][multicontainer] | Multi-container samples (i.e nginx) | -|
For more Cloud Run samples beyond PHP, see the main list in the [Cloud Run Samples repository](https://github.com/GoogleCloudPlatform/cloud-run-samples).
@@ -90,4 +91,5 @@ for more information.
[run_deploy]: https://cloud.google.com/run/docs/deploying
[helloworld]: helloworld/
[laravel]: laravel/
+[multicontainer]: multi-container/
[run_button_helloworld]: https://deploy.cloud.run/?dir=run/helloworld
diff --git a/run/multi-container/hello-php-nginx-sample/README.md b/run/multi-container/hello-php-nginx-sample/README.md
new file mode 100644
index 0000000000..be1c8c4685
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/README.md
@@ -0,0 +1,81 @@
+# Deploy simple nginx multi-container service NGINX/PHP-FPM
+
+A Google Cloud Project is required in order to run the sample.
+
+## Enable required APIs
+
+The project should have the following API's enabled:
+
+* Cloud Run
+* Artifact Registry
+
+```bash
+gcloud services enable run.googleapis.com artifactregistry.googleapis.com
+```
+
+## Getting started
+
+Declare the following environment variables.
+```bash
+# References your Google Cloud Project
+export PROJECT_ID=
+# References your Artifact Registry repo name
+export REPO_NAME="default"
+# References your resource location
+export REGION="us-west1"
+# References final Cloud Run multi-contaienr service name
+export MC_SERVICE_NAME="mc-php-example"
+```
+
+1. Authenticate in [gcloud cli](https://cloud.google.com/sdk/gcloud).
+
+```bash
+gcloud auth login
+```
+
+2. Create a repository within [Artifact Registry](https://cloud.google.com/artifact-registry).
+
+```bash
+gcloud artifacts repositories create ${REPO_NAME} --repository-format=docker
+```
+
+3. Build the `nginx` and `hellophp` container images for our multi-container service.
+
+```bash
+# Creating image from the Dockerfile within nginx/ dir.
+gcloud builds submit --tag=${REGION}-docker.pkg.dev/${PROJECT_ID}/${REPO_NAME}/nginx ./nginx
+
+# Creating image from the Dockerfile within php-app/ dir.
+gcloud builds submit --tag=${REGION}-docker.pkg.dev/${PROJECT_ID}/${REPO_NAME}/php ./php-app
+```
+
+4. Configure the service with the appropriate memory limit.
+
+You will see as you read through `service.yaml`, that the memory limit has been explicitly
+set to `320Mi` due to container concurrency of `1` with a single `fpm` worker.
+See how we got [here](https://cloud.google.com/run/docs/configuring/services/memory-limits#optimizing) and read more about how to [optimize for concurrency](https://cloud.google.com/run/docs/tips/general#optimize_concurrency).
+
+5. Deploy the multi-container service.
+
+From within `service.yaml`, customize the `service.yaml` file with your own project values by replacing
+the following `PROJECT_ID`, `MC_SERVICE_NAME`, `REGION`, and `REPO_NAME`.
+
+Once you've replaced the values, you can deploy from root directory (`hello-php-nginx-sample/`).
+
+```sh
+gcloud run services replace service.yaml
+```
+
+By default, the above command will deploy the following containers into a single service:
+
+* `nginx`: `serving` ingress container (entrypoint)
+* `hellophp`: `application` container
+
+The Cloud Run Multi-container service will default access to port `8080`,
+where `nginx` container will be listening and proxy request over to `hellophp` container at port `9000`.
+
+Verify by using curl to send an authenticated request:
+
+```bash
+curl --header "Authorization: Bearer $(gcloud auth print-identity-token)"
+```
diff --git a/run/multi-container/hello-php-nginx-sample/composer.json b/run/multi-container/hello-php-nginx-sample/composer.json
new file mode 100644
index 0000000000..41d1aef360
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/composer.json
@@ -0,0 +1,5 @@
+{
+ "require": {
+ "google/cloud-run": "^0.6.0"
+ }
+}
diff --git a/run/multi-container/hello-php-nginx-sample/nginx/Dockerfile b/run/multi-container/hello-php-nginx-sample/nginx/Dockerfile
new file mode 100644
index 0000000000..ee5d606a3a
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/nginx/Dockerfile
@@ -0,0 +1,28 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START cloudrun_hello_mc_nginx_dockerfile]
+
+# Context: ./
+# Read more about context: https://docs.docker.com/build/building/context/
+# We assume here that required file paths are getting copied
+# from the perspective of this directory.
+
+FROM nginx:1-alpine
+
+COPY ./nginx.conf /etc/nginx/conf.d
+
+COPY index.php /var/www/html/index.php
+
+# [END cloudrun_hello_mc_nginx_dockerfile]
diff --git a/run/multi-container/hello-php-nginx-sample/nginx/index.php b/run/multi-container/hello-php-nginx-sample/nginx/index.php
new file mode 100644
index 0000000000..945c0cb24a
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/nginx/index.php
@@ -0,0 +1,19 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+
+
+
+
+
+ ./php-app
+ ./nginx
+
+
+ ./vendor
+
+
+
+
+
+
+
+ test
+
+
+
+
+
+
+
diff --git a/run/multi-container/hello-php-nginx-sample/service.yaml b/run/multi-container/hello-php-nginx-sample/service.yaml
new file mode 100644
index 0000000000..eef61bffb5
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/service.yaml
@@ -0,0 +1,59 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START cloudrun_mc_hello_php_nginx_mc]
+apiVersion: serving.knative.dev/v1
+kind: Service
+metadata:
+ name: "MC_SERVICE_NAME"
+ labels:
+ cloud.googleapis.com/location: "REGION"
+ annotations:
+ run.googleapis.com/launch-stage: BETA
+ run.googleapis.com/description: sample tutorial service
+ run.googleapis.com/ingress: all
+spec:
+ template:
+ metadata:
+ annotations:
+ run.googleapis.com/execution-environment: gen2
+ # Defines container startup order within multi-container service.
+ # Below requires side-car "hellophp" container to spin up before nginx proxy (entrypoint).
+ # https://cloud.google.com/run/docs/configuring/containers#container-ordering
+ run.googleapis.com/container-dependencies: '{"nginx":["hellophp"]}'
+ spec:
+ containerConcurrency: 1
+ containers:
+ - name: nginx
+ image: "REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME/nginx"
+ ports:
+ - name: http1
+ containerPort: 8080
+ resources:
+ limits:
+ cpu: 500m
+ memory: 256Mi
+ - name: hellophp
+ image: "REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME/php"
+ env:
+ - name: PORT
+ value: "9000"
+ resources:
+ limits:
+ cpu: 1000m
+ # Explore more how to set memory limits in Cloud Run
+ # https://cloud.google.com/run/docs/tips/general#optimize_concurrency
+ # https://cloud.google.com/run/docs/configuring/services/memory-limits#optimizing
+ memory: 320Mi
+# [END cloudrun_mc_hello_php_nginx_mc]
diff --git a/run/multi-container/hello-php-nginx-sample/test/TestCase.php b/run/multi-container/hello-php-nginx-sample/test/TestCase.php
new file mode 100644
index 0000000000..5d353a7a05
--- /dev/null
+++ b/run/multi-container/hello-php-nginx-sample/test/TestCase.php
@@ -0,0 +1,198 @@
+ self::$region, 'service' => self::$mcServiceName]);
+
+ // Declaring Cloud Build image tags
+ self::$nginxImage = sprintf('%s-docker.pkg.dev/%s/%s/nginx', self::$region, self::$projectId, self::$repoName);
+ self::$appImage = sprintf('%s-docker.pkg.dev/%s/%s/php', self::$region, self::$projectId, self::$repoName);
+ }
+
+ /**
+ * Execute yaml substitution
+ */
+ private static function doYamlSubstitution()
+ {
+ $subCmd = sprintf(
+ 'sed -i -e s/MC_SERVICE_NAME/%s/g -e s/REGION/%s/g -e s/REPO_NAME/%s/g -e s/PROJECT_ID/%s/g service.yaml',
+ self::$mcServiceName,
+ self::$region,
+ self::$repoName,
+ self::$projectId
+ );
+
+ return self::execCmd($subCmd);
+ }
+
+ /**
+ * Build both nginx + hello php container images
+ * Return true/false if image builds were successful
+ */
+ private static function buildImages()
+ {
+ if (false === self::$mcService->build(self::$nginxImage, [], './nginx')) {
+ return false;
+ }
+ if (false === self::$mcService->build(self::$appImage, [], './php-app')) {
+ return false;
+ }
+ }
+
+ /**
+ * Instatiate and build necessary resources
+ * required before multi-container deployment
+ */
+ private static function beforeDeploy()
+ {
+ self::setUpDeploymentVars();
+ self::buildImages();
+ self::doYamlSubstitution();
+
+ // Suppress gcloud prompts during deployment.
+ putenv('CLOUDSDK_CORE_DISABLE_PROMPTS=1');
+ }
+
+ /**
+ * Deploy the Cloud Run services (nginx, php app)
+ */
+ private static function doDeploy()
+ {
+ // Execute multi-container service deployment
+ $mcCmd = sprintf('gcloud run services replace service.yaml --region %s --quiet', self::$region);
+
+ return self::execCmd($mcCmd);
+ }
+
+ /**
+ * Delete a deployed Cloud Run MC service and related images.
+ */
+ private static function doDelete()
+ {
+ self::$mcService->delete();
+ self::$mcService->deleteImage(self::$nginxImage);
+ self::$mcService->deleteImage(self::$appImage);
+ }
+
+ /**
+ * Test that the multi-container is running with both
+ * serving and sidecar running as expected
+ */
+ public function testService()
+ {
+ $baseUri = self::getBaseUri();
+ $mcStatusCmd = sprintf(
+ 'gcloud run services describe %s --region %s --format "value(status.conditions[0].type)"',
+ self::$mcServiceName,
+ self::$region
+ );
+ $mcStatus = self::execCmd($mcStatusCmd);
+
+ if (empty($baseUri) or $mcStatus != 'Ready') {
+ return false;
+ }
+
+ // create middleware
+ $middleware = ApplicationDefaultCredentials::getIdTokenMiddleware($baseUri);
+ $stack = HandlerStack::create();
+ $stack->push($middleware);
+
+ // create the HTTP client
+ $client = new Client([
+ 'handler' => $stack,
+ 'auth' => 'google_auth',
+ 'base_uri' => $baseUri,
+ ]);
+
+ // Check that the page renders default phpinfo html and indications it is the main php app
+ $resp = $client->get('/');
+ $this->assertEquals('200', $resp->getStatusCode());
+ $this->assertStringContainsString('This is main php app. Hello PHP World!', (string) $resp->getBody());
+ }
+
+ /**
+ * Retrieve Cloud Run multi-container service url
+ */
+ public function getBaseUri()
+ {
+ $mcUrlCmd = sprintf(
+ 'gcloud run services describe %s --region %s --format "value(status.url)"',
+ self::$mcServiceName,
+ self::$region
+ );
+ $mcUrl = self::execCmd($mcUrlCmd);
+
+ return $mcUrl;
+ }
+}
From e6661e81b4b27d9786d337091e424dc75cd63e23 Mon Sep 17 00:00:00 2001
From: Patti Shin
Date: Fri, 25 Aug 2023 12:56:29 -0700
Subject: [PATCH 068/285] fix: updates cloud run mc php nginx sample (#1913)
---
.../hello-php-nginx-sample/README.md | 5 ++--
.../hello-php-nginx-sample/php-app/Dockerfile | 25 +++++++++++++------
.../php-app/opcache.ini | 11 --------
.../hello-php-nginx-sample/service.yaml | 4 +--
4 files changed, 23 insertions(+), 22 deletions(-)
delete mode 100644 run/multi-container/hello-php-nginx-sample/php-app/opcache.ini
diff --git a/run/multi-container/hello-php-nginx-sample/README.md b/run/multi-container/hello-php-nginx-sample/README.md
index be1c8c4685..939e894fd3 100644
--- a/run/multi-container/hello-php-nginx-sample/README.md
+++ b/run/multi-container/hello-php-nginx-sample/README.md
@@ -51,10 +51,11 @@ gcloud builds submit --tag=${REGION}-docker.pkg.dev/${PROJECT_ID}/${REPO_NAME}/p
4. Configure the service with the appropriate memory limit.
-You will see as you read through `service.yaml`, that the memory limit has been explicitly
-set to `320Mi` due to container concurrency of `1` with a single `fpm` worker.
+You will see as you read through `service.yaml`, that the memory limit has been explicitly set to `335M`. This leaves ~143M for PHP processes after allocating 192M for opcache.
See how we got [here](https://cloud.google.com/run/docs/configuring/services/memory-limits#optimizing) and read more about how to [optimize for concurrency](https://cloud.google.com/run/docs/tips/general#optimize_concurrency).
+**Note:** This sample does not contain extra configuration to tune php-fpm settings to specify the number of workers to correlate with the container concurrency.
+
5. Deploy the multi-container service.
From within `service.yaml`, customize the `service.yaml` file with your own project values by replacing
diff --git a/run/multi-container/hello-php-nginx-sample/php-app/Dockerfile b/run/multi-container/hello-php-nginx-sample/php-app/Dockerfile
index 6ba5fd2263..3f329813c2 100644
--- a/run/multi-container/hello-php-nginx-sample/php-app/Dockerfile
+++ b/run/multi-container/hello-php-nginx-sample/php-app/Dockerfile
@@ -22,14 +22,25 @@
FROM php:8-fpm-alpine
-# Use the default production configuration
-RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
-
-RUN docker-php-ext-install opcache
-
-# COPY php.ini /usr/local/etc/php
-COPY opcache.ini /usr/local/etc/php/conf.d/opcache.ini
+# Configure PHP for Cloud Run.
+# Precompile PHP code with opcache.
+RUN docker-php-ext-install -j "$(nproc)" opcache
+RUN set -ex; \
+ { \
+ echo "; Cloud Run enforces memory & timeouts"; \
+ echo "memory_limit = -1"; \
+ echo "; Configure Opcache for Containers"; \
+ echo "opcache.enable = 1"; \
+ echo "opcache.validate_timestamps = 0"; \
+ echo "opcache.memory_consumption = 192"; \
+ echo "opcache.max_accelerated_files = 10000"; \
+ echo "opcache.max_wasted_percentage = 10"; \
+ echo "opcache.interned_strings_buffer = 16";\
+ } > "$PHP_INI_DIR/conf.d/cloud-run.ini"
COPY . /var/www/html/
+# Use the default production configuration
+RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+
# [END cloudrun_hello_mc_nginx_app_dockerfile]
diff --git a/run/multi-container/hello-php-nginx-sample/php-app/opcache.ini b/run/multi-container/hello-php-nginx-sample/php-app/opcache.ini
deleted file mode 100644
index d75f772c5f..0000000000
--- a/run/multi-container/hello-php-nginx-sample/php-app/opcache.ini
+++ /dev/null
@@ -1,11 +0,0 @@
-; Configure Cloud Run memory
-memory_limit = -1
-
-; Configure Opcache for containers
-[opcache]
-opcache.enable=1
-opcache.validate_timestamps=0
-opcache.max_accelerated_files=10000
-opcache.memory_consumption=192
-opcache.max_wasted_percentage=10
-opcache.interned_strings_buffer=16
diff --git a/run/multi-container/hello-php-nginx-sample/service.yaml b/run/multi-container/hello-php-nginx-sample/service.yaml
index eef61bffb5..685e25252a 100644
--- a/run/multi-container/hello-php-nginx-sample/service.yaml
+++ b/run/multi-container/hello-php-nginx-sample/service.yaml
@@ -43,7 +43,7 @@ spec:
resources:
limits:
cpu: 500m
- memory: 256Mi
+ memory: 256M
- name: hellophp
image: "REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME/php"
env:
@@ -55,5 +55,5 @@ spec:
# Explore more how to set memory limits in Cloud Run
# https://cloud.google.com/run/docs/tips/general#optimize_concurrency
# https://cloud.google.com/run/docs/configuring/services/memory-limits#optimizing
- memory: 320Mi
+ memory: 335M
# [END cloudrun_mc_hello_php_nginx_mc]
From 24de8f1781a84419c1b4dd33ff33500dacc6ace1 Mon Sep 17 00:00:00 2001
From: Tatiane Tosta <91583351+ttosta-google@users.noreply.github.com>
Date: Wed, 30 Aug 2023 17:06:13 +0000
Subject: [PATCH 069/285] chore: update code owners to infra-db-sdk (#1912)
---
.github/blunderbuss.yml | 4 ++--
CODEOWNERS | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/blunderbuss.yml b/.github/blunderbuss.yml
index a0aaa1d312..a5f6f2b49e 100644
--- a/.github/blunderbuss.yml
+++ b/.github/blunderbuss.yml
@@ -8,7 +8,7 @@ assign_issues_by:
- labels:
- 'api: cloudsql'
to:
- - GoogleCloudPlatform/infra-db-dpes
+ - GoogleCloudPlatform/infra-db-sdk
- labels:
- 'api: cloudiot'
to:
@@ -28,7 +28,7 @@ assign_prs_by:
- labels:
- 'api: cloudsql'
to:
- - GoogleCloudPlatform/infra-db-dpes
+ - GoogleCloudPlatform/infra-db-sdk
- labels:
- 'api: cloudiot'
to:
diff --git a/CODEOWNERS b/CODEOWNERS
index 45d901e1f8..d51342f6ae 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -19,7 +19,7 @@
.kokoro @GoogleCloudPlatform/php-admins
/bigtable/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
-/cloud_sql/**/*.php @GoogleCloudPlatform/infra-db-dpes @GoogleCloudPlatform/php-samples-reviewers
+/cloud_sql/**/*.php @GoogleCloudPlatform/infra-db-sdk @GoogleCloudPlatform/php-samples-reviewers
/datastore/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
/firestore/**/*.php @GoogleCloudPlatform/cloud-native-db-dpes @GoogleCloudPlatform/php-samples-reviewers
/storage/ @GoogleCloudPlatform/cloud-storage-dpe @GoogleCloudPlatform/php-samples-reviewers
From fee6e59a9ef14920b34e9fcefae8e84d8bea6806 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Fri, 1 Sep 2023 04:01:26 +0530
Subject: [PATCH 070/285] feat(dlp): Sample for Inspect BigQuery for sensitive
data with sampling (#1835)
---
dlp/src/inspect_bigquery_with_sampling.php | 178 +++++++++++++
dlp/test/dlpLongRunningTest.php | 106 ++++----
dlp/test/dlpTest.php | 295 ++++++++++++++-------
3 files changed, 433 insertions(+), 146 deletions(-)
create mode 100644 dlp/src/inspect_bigquery_with_sampling.php
diff --git a/dlp/src/inspect_bigquery_with_sampling.php b/dlp/src/inspect_bigquery_with_sampling.php
new file mode 100644
index 0000000000..ca8c911947
--- /dev/null
+++ b/dlp/src/inspect_bigquery_with_sampling.php
@@ -0,0 +1,178 @@
+topic($topicId);
+
+ // Specify the BigQuery table to be inspected.
+ $bigqueryTable = (new BigQueryTable())
+ ->setProjectId($projectId)
+ ->setDatasetId($datasetId)
+ ->setTableId($tableId);
+
+ $bigQueryOptions = (new BigQueryOptions())
+ ->setTableReference($bigqueryTable)
+ ->setRowsLimit(1000)
+ ->setSampleMethod(SampleMethod::RANDOM_START)
+ ->setIdentifyingFields([
+ (new FieldId())
+ ->setName('name')
+ ]);
+
+ $storageConfig = (new StorageConfig())
+ ->setBigQueryOptions($bigQueryOptions);
+
+ // Specify the type of info the inspection will look for.
+ // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
+ $personNameInfoType = (new InfoType())
+ ->setName('PERSON_NAME');
+ $infoTypes = [$personNameInfoType];
+
+ // Specify how the content should be inspected.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true);
+
+ // Specify the action that is triggered when the job completes.
+ $pubSubAction = (new PublishToPubSub())
+ ->setTopic($topic->name());
+
+ $action = (new Action())
+ ->setPubSub($pubSubAction);
+
+ // Configure the long running job we want the service to perform.
+ $inspectJob = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Listen for job notifications via an existing topic/subscription.
+ $subscription = $topic->subscription($subscriptionId);
+
+ // Submit request
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJob
+ ]);
+
+ // Poll Pub/Sub using exponential backoff until job finishes
+ // Consider using an asynchronous execution model such as Cloud Functions
+ $attempt = 1;
+ $startTime = time();
+ do {
+ foreach ($subscription->pull() as $message) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
+ $subscription->acknowledge($message);
+ // Get the updated job. Loop to avoid race condition with DLP API.
+ do {
+ $job = $dlp->getDlpJob($job->getName());
+ } while ($job->getState() == JobState::RUNNING);
+ break 2; // break from parent do while
+ }
+ }
+ printf('Waiting for job to complete' . PHP_EOL);
+ // Exponential backoff with max delay of 60 seconds
+ sleep(min(60, pow(2, ++$attempt)));
+ } while (time() - $startTime < 600); // 10 minute timeout
+
+ // Print finding counts
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_bigquery_with_sampling]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpLongRunningTest.php b/dlp/test/dlpLongRunningTest.php
index 81ea7527ae..3f32563a18 100644
--- a/dlp/test/dlpLongRunningTest.php
+++ b/dlp/test/dlpLongRunningTest.php
@@ -63,6 +63,47 @@ public static function tearDownAfterClass(): void
self::$subscription->delete();
}
+ private function writeTempSample(string $sampleName, array $replacements): string
+ {
+ $sampleFile = sprintf('%s/../src/%s.php', __DIR__, $sampleName);
+ $tmpFileName = 'dlp_' . basename($sampleFile, '.php');
+ $tmpFilePath = sys_get_temp_dir() . '/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements[$sampleName] = $tmpFileName;
+ $fileContent = strtr($fileContent, $replacements);
+
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent
+ );
+
+ return $tmpFilePath;
+ }
+
+ public function dlpJobResponse()
+ {
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $result = $this->prophesize(Result::class);
+ $infoTypeStats1 = $this->prophesize(InfoTypeStats::class);
+ $infoTypeStats1->getInfoType()->shouldBeCalled()->willReturn((new InfoType())->setName('PERSON_NAME'));
+ $infoTypeStats1->getCount()->shouldBeCalled()->willReturn(5);
+ $result->getInfoTypeStats()->shouldBeCalled()->willReturn([$infoTypeStats1->reveal()]);
+
+ $inspectDetails = $this->prophesize(InspectDataSourceDetails::class);
+ $inspectDetails->getResult()->shouldBeCalled()->willReturn($result->reveal());
+
+ $getDlpJobResponse = $this->prophesize(DlpJob::class);
+ $getDlpJobResponse->getName()->shouldBeCalled()->willReturn('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812');
+ $getDlpJobResponse->getState()->shouldBeCalled()->willReturn(JobState::DONE);
+ $getDlpJobResponse->getInspectDetails()->shouldBeCalled()->willReturn($inspectDetails->reveal());
+
+ return ['createDlpJob' => $createDlpJobResponse, 'getDlpJob' => $getDlpJobResponse];
+ }
+
public function testInspectDatastore()
{
$kind = 'Person';
@@ -102,31 +143,14 @@ public function testInspectGCS()
// Mock the necessary objects and methods
$dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
- $createDlpJobResponse = (new DlpJob())
- ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
- ->setState(JobState::PENDING);
-
- $getDlpJobResponse = (new DlpJob())
- ->setName('projects/' . self::$projectId . '/dlpJobs/job-name-123')
- ->setState(JobState::DONE)
- ->setInspectDetails((new InspectDataSourceDetails())
- ->setResult((new Result())
- ->setInfoTypeStats([
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('PERSON_NAME'))
- ->setCount(3),
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('CREDIT_CARD_NUMBER'))
- ->setCount(3)
- ])));
-
+ $dlpJobResponse = $this->dlpJobResponse();
$dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
->shouldBeCalled()
- ->willReturn($createDlpJobResponse);
+ ->willReturn($dlpJobResponse['createDlpJob']);
$dlpServiceClientMock->getDlpJob(Argument::any())
->shouldBeCalled()
- ->willReturn($getDlpJobResponse);
+ ->willReturn($dlpJobResponse['getDlpJob']);
$pubSubClientMock = $this->prophesize(PubSubClient::class);
$topicMock = $this->prophesize(Topic::class);
@@ -152,50 +176,42 @@ public function testInspectGCS()
$messageMock->attributes()
->shouldBeCalledTimes(2)
- ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/job-name-123']);
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
$subscriptionMock->acknowledge(Argument::any())
->shouldBeCalled()
->willReturn($messageMock->reveal());
// Creating a temp file for testing.
- $sampleFile = __DIR__ . '/../src/inspect_gcs.php';
- $tmpFileName = basename($sampleFile, '.php') . '_temp';
- $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+ $callFunction = sprintf(
+ "dlp_inspect_gcs('%s','%s','%s','%s','%s');",
+ self::$projectId,
+ $topicId,
+ $subscriptionId,
+ $bucketName,
+ $objectName,
+ );
- $fileContent = file_get_contents($sampleFile);
- $replacements = [
+ $tmpFile = $this->writeTempSample('inspect_gcs', [
'$dlp = new DlpServiceClient();' => 'global $dlp;',
'$pubsub = new PubSubClient();' => 'global $pubsub;',
- 'inspect_gcs' => $tmpFileName
- ];
- $fileContent = strtr($fileContent, $replacements);
- $tmpFile = file_put_contents(
- $tmpFilePath,
- $fileContent
- );
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
global $dlp;
global $pubsub;
$dlp = $dlpServiceClientMock->reveal();
$pubsub = $pubSubClientMock->reveal();
- // Call the method under test
- $output = $this->runFunctionSnippet($tmpFileName, [
- self::$projectId,
- $topicId,
- $subscriptionId,
- $bucketName,
- $objectName,
- ]);
-
- // delete topic , subscription , and temp file
- unlink($tmpFilePath);
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
// Assert the expected behavior or outcome
$this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
$this->assertStringContainsString('infoType PERSON_NAME', $output);
- $this->assertStringContainsString('infoType CREDIT_CARD_NUMBER', $output);
}
public function testNumericalStats()
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 38c4d63318..59921d9365 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -30,6 +30,10 @@
use Google\Cloud\Dlp\V2\InfoTypeStats;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
+use Google\Cloud\PubSub\Message;
+use Google\Cloud\PubSub\PubSubClient;
+use Google\Cloud\PubSub\Subscription;
+use Google\Cloud\PubSub\Topic;
use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails;
use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult;
use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult\KAnonymityEquivalenceClass;
@@ -53,6 +57,65 @@ class dlpTest extends TestCase
use TestTrait;
use RetryTrait;
use ProphecyTrait;
+ private static $topic;
+ private static $subscription;
+
+ public static function setUpBeforeClass(): void
+ {
+ $uniqueName = sprintf('dlp-%s', microtime(true));
+ $pubsub = new PubSubClient();
+ self::$topic = $pubsub->topic($uniqueName);
+ self::$topic->create();
+ self::$subscription = self::$topic->subscription($uniqueName);
+ self::$subscription->create();
+ }
+
+ public static function tearDownAfterClass(): void
+ {
+ self::$topic->delete();
+ self::$subscription->delete();
+ }
+
+ private function writeTempSample(string $sampleName, array $replacements): string
+ {
+ $sampleFile = sprintf('%s/../src/%s.php', __DIR__, $sampleName);
+ $tmpFileName = 'dlp_' . basename($sampleFile, '.php');
+ $tmpFilePath = sys_get_temp_dir() . '/' . $tmpFileName . '.php';
+
+ $fileContent = file_get_contents($sampleFile);
+ $replacements[$sampleName] = $tmpFileName;
+ $fileContent = strtr($fileContent, $replacements);
+
+ $tmpFile = file_put_contents(
+ $tmpFilePath,
+ $fileContent
+ );
+
+ return $tmpFilePath;
+ }
+
+ public function dlpJobResponse()
+ {
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $result = $this->prophesize(Result::class);
+ $infoTypeStats1 = $this->prophesize(InfoTypeStats::class);
+ $infoTypeStats1->getInfoType()->shouldBeCalled()->willReturn((new InfoType())->setName('PERSON_NAME'));
+ $infoTypeStats1->getCount()->shouldBeCalled()->willReturn(5);
+ $result->getInfoTypeStats()->shouldBeCalled()->willReturn([$infoTypeStats1->reveal()]);
+
+ $inspectDetails = $this->prophesize(InspectDataSourceDetails::class);
+ $inspectDetails->getResult()->shouldBeCalled()->willReturn($result->reveal());
+
+ $getDlpJobResponse = $this->prophesize(DlpJob::class);
+ $getDlpJobResponse->getName()->shouldBeCalled()->willReturn('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812');
+ $getDlpJobResponse->getState()->shouldBeCalled()->willReturn(JobState::DONE);
+ $getDlpJobResponse->getInspectDetails()->shouldBeCalled()->willReturn($inspectDetails->reveal());
+
+ return ['createDlpJob' => $createDlpJobResponse, 'getDlpJob' => $getDlpJobResponse];
+ }
public function testInspectImageFile()
{
@@ -1033,52 +1096,18 @@ public function testDeidentifyCloudStorage()
$dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
- $createDlpJobResponse = (new DlpJob())
- ->setName('projects/' . self::$projectId . '/dlpJobs/1234')
- ->setState(JobState::PENDING);
-
- $getDlpJobResponse = (new DlpJob())
- ->setName('projects/' . self::$projectId . '/dlpJobs/1234')
- ->setState(JobState::DONE)
- ->setInspectDetails((new InspectDataSourceDetails())
- ->setResult((new Result())
- ->setInfoTypeStats([
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('PERSON_NAME'))
- ->setCount(6),
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('EMAIL_ADDRESS'))
- ->setCount(9)
- ])));
-
+ $dlpJobResponse = $this->dlpJobResponse();
$dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
->shouldBeCalled()
- ->willReturn($createDlpJobResponse);
+ ->willReturn($dlpJobResponse['createDlpJob']);
$dlpServiceClientMock->getDlpJob(Argument::any())
->shouldBeCalled()
- ->willReturn($getDlpJobResponse);
+ ->willReturn($dlpJobResponse['getDlpJob']);
// Creating a temp file for testing.
- $sampleFile = __DIR__ . '/../src/deidentify_cloud_storage.php';
- $tmpFileName = basename($sampleFile, '.php') . '_temp';
- $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
-
- $fileContent = file_get_contents($sampleFile);
- $replacements = [
- '$dlp = new DlpServiceClient();' => 'global $dlp;',
- 'deidentify_cloud_storage' => $tmpFileName
- ];
- $fileContent = strtr($fileContent, $replacements);
- $tmpFile = file_put_contents(
- $tmpFilePath,
- $fileContent
- );
- global $dlp;
-
- $dlp = $dlpServiceClientMock->reveal();
-
- $output = $this->runFunctionSnippet($tmpFileName, [
+ $callFunction = sprintf(
+ "dlp_deidentify_cloud_storage('%s','%s','%s','%s','%s','%s','%s','%s');",
self::$projectId,
$inputgcsPath,
$outgcsPath,
@@ -1087,14 +1116,24 @@ public function testDeidentifyCloudStorage()
$imageRedactTemplateName,
$datasetId,
$tableId
+ );
+
+ $tmpFile = $this->writeTempSample('deidentify_cloud_storage', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
- // delete a temp file.
- unlink($tmpFilePath);
+ $dlp = $dlpServiceClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
$this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
$this->assertStringContainsString('infoType PERSON_NAME', $output);
- $this->assertStringContainsString('infoType EMAIL_ADDRESS', $output);
}
public function testDeidentifyReplaceInfotype()
@@ -1151,33 +1190,27 @@ public function testKAnonymityWithEntityId()
->willReturn($getDlpJobResponse);
// Creating a temp file for testing.
- $sampleFile = __DIR__ . '/../src/k_anonymity_with_entity_id.php';
- $tmpFileName = basename($sampleFile, '.php') . '_temp';
- $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+ $callFunction = sprintf(
+ "dlp_k_anonymity_with_entity_id('%s','%s','%s',%s);",
+ self::$projectId,
+ $datasetId,
+ $tableId,
+ "['Age', 'Mystery']"
+ );
- $fileContent = file_get_contents($sampleFile);
- $replacements = [
+ $tmpFile = $this->writeTempSample('k_anonymity_with_entity_id', [
'$dlp = new DlpServiceClient();' => 'global $dlp;',
- 'k_anonymity_with_entity_id' => $tmpFileName
- ];
- $fileContent = strtr($fileContent, $replacements);
- $tmpFile = file_put_contents(
- $tmpFilePath,
- $fileContent,
- );
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
global $dlp;
$dlp = $dlpServiceClientMock->reveal();
- // Call the method under test
- $output = $this->runFunctionSnippet($tmpFileName, [
- self::$projectId,
- $datasetId,
- $tableId,
- ['Age', 'Mystery']
- ]);
- // delete temp file
- unlink($tmpFilePath);
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
// Assert the expected behavior or outcome
$this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
@@ -1252,29 +1285,16 @@ public function testInspectSendDataToHybridJobTrigger()
// Mock the necessary objects and methods
$dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
-
- $getDlpJobResponse = (new DlpJob())
- ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
- ->setState(JobState::DONE)
- ->setInspectDetails((new InspectDataSourceDetails())
- ->setResult((new Result())
- ->setInfoTypeStats([
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('PERSON_NAME'))
- ->setCount(13),
- (new InfoTypeStats())
- ->setInfoType((new InfoType())->setName('PHONE_NUMBER'))
- ->setCount(5)
- ])));
+ $dlpJobResponse = $this->dlpJobResponse();
$dlpServiceClientMock
->activateJobTrigger($fullTriggerId)
->shouldBeCalled()
- ->willReturn($getDlpJobResponse);
+ ->willReturn($dlpJobResponse['getDlpJob']);
$dlpServiceClientMock
->listDlpJobs(Argument::any(), Argument::type('array'))
- ->willReturn([$getDlpJobResponse]);
+ ->willReturn([$dlpJobResponse['getDlpJob']]);
$dlpServiceClientMock
->hybridInspectJobTrigger(Argument::any(), Argument::type('array'))
@@ -1283,39 +1303,32 @@ public function testInspectSendDataToHybridJobTrigger()
$dlpServiceClientMock->getDlpJob(Argument::any())
->shouldBeCalled()
- ->willReturn($getDlpJobResponse);
+ ->willReturn($dlpJobResponse['getDlpJob']);
// Creating a temp file for testing.
- $sampleFile = __DIR__ . '/../src/inspect_send_data_to_hybrid_job_trigger.php';
- $tmpFileName = basename($sampleFile, '.php') . '_temp';
- $tmpFilePath = __DIR__ . '/../src/' . $tmpFileName . '.php';
+ $callFunction = sprintf(
+ "dlp_inspect_send_data_to_hybrid_job_trigger('%s','%s','%s');",
+ self::$projectId,
+ $triggerId,
+ $string
+ );
- $fileContent = file_get_contents($sampleFile);
- $replacements = [
+ $tmpFile = $this->writeTempSample('inspect_send_data_to_hybrid_job_trigger', [
'$dlp = new DlpServiceClient();' => 'global $dlp;',
- 'inspect_send_data_to_hybrid_job_trigger' => $tmpFileName
- ];
- $fileContent = strtr($fileContent, $replacements);
- $tmpFile = file_put_contents(
- $tmpFilePath,
- $fileContent
- );
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
global $dlp;
$dlp = $dlpServiceClientMock->reveal();
- $output = $this->runFunctionSnippet($tmpFileName, [
- self::$projectId,
- $triggerId,
- $string
- ]);
-
- // delete a temp file.
- unlink($tmpFilePath);
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
$this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
$this->assertStringContainsString('infoType PERSON_NAME', $output);
- $this->assertStringContainsString('infoType PHONE_NUMBER', $output);
$output = $this->runFunctionSnippet('delete_trigger', [
self::$projectId,
@@ -1323,4 +1336,84 @@ public function testInspectSendDataToHybridJobTrigger()
]);
$this->assertStringContainsString('Successfully deleted trigger ' . $fullTriggerId, $output);
}
+
+ public function testInspectBigQueryWithSampling()
+ {
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ $topicId = self::$topic->name();
+ $subscriptionId = self::$subscription->name();
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic($topicId)
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . $topicId);
+
+ $topicMock->subscription($subscriptionId)
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_bigquery_with_sampling('%s','%s','%s','%s','%s','%s');",
+ self::$projectId,
+ $topicId,
+ $subscriptionId,
+ 'bigquery-public-data',
+ 'usa_names',
+ 'usa_1910_current'
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_bigquery_with_sampling', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ }
}
From 338fab35a356fecfb70823b1b231a9a069e1716a Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Fri, 1 Sep 2023 21:15:57 +0530
Subject: [PATCH 071/285] feat(dlp): Sample for inspect GCS, BigQuery, and
Datastore send to scc (#1867)
---
dlp/README.md | 62 +++++++
dlp/src/inspect_bigquery_send_to_scc.php | 147 +++++++++++++++
dlp/src/inspect_datastore_send_to_scc.php | 145 +++++++++++++++
dlp/src/inspect_gcs_send_to_scc.php | 140 +++++++++++++++
dlp/src/inspect_gcs_with_sampling.php | 166 +++++++++++++++++
dlp/test/dlpTest.php | 206 ++++++++++++++++++++++
6 files changed, 866 insertions(+)
create mode 100644 dlp/src/inspect_bigquery_send_to_scc.php
create mode 100644 dlp/src/inspect_datastore_send_to_scc.php
create mode 100644 dlp/src/inspect_gcs_send_to_scc.php
create mode 100644 dlp/src/inspect_gcs_with_sampling.php
diff --git a/dlp/README.md b/dlp/README.md
index b7e1e59abd..b5c09d3157 100644
--- a/dlp/README.md
+++ b/dlp/README.md
@@ -45,6 +45,68 @@ This simple command-line application demonstrates how to invoke
See the [DLP Documentation](https://cloud.google.com/dlp/docs/inspecting-text) for more information.
+## Testing
+
+### Setup
+- Ensure that `GOOGLE_APPLICATION_CREDENTIALS` points to authorized service account credentials file.
+- [Create a Google Cloud Project](https://console.cloud.google.com/projectcreate) and set the `GOOGLE_PROJECT_ID` environment variable.
+ ```
+ export GOOGLE_PROJECT_ID=YOUR_PROJECT_ID
+ ```
+- [Create a Google Cloud Storage bucket](https://console.cloud.google.com/storage) and upload [test.txt](src/test/data/test.txt).
+ - Set the `GOOGLE_STORAGE_BUCKET` environment variable.
+ - Set the `GCS_PATH` environment variable to point to the path for the bucket file.
+ ```
+ export GOOGLE_STORAGE_BUCKET=YOUR_BUCKET
+ export GCS_PATH=gs://GOOGLE_STORAGE_BUCKET/test.txt
+ ```
+- Set the `DLP_DEID_WRAPPED_KEY` environment variable to an AES-256 key encrypted ('wrapped') [with a Cloud Key Management Service (KMS) key](https://cloud.google.com/kms/docs/encrypt-decrypt).
+- Set the `DLP_DEID_KEY_NAME` environment variable to the path-name of the Cloud KMS key you wrapped `DLP_DEID_WRAPPED_KEY` with.
+ ```
+ export DLP_DEID_WRAPPED_KEY=YOUR_ENCRYPTED_AES_256_KEY
+ export DLP_DEID_KEY_NAME=projects/GOOGLE_PROJECT_ID/locations/YOUR_LOCATION/keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME
+ ```
+- [Create a De-identify templates](https://console.cloud.google.com/security/dlp/create/template;template=deidentifyTemplate)
+ - Create default de-identify template for unstructured file.
+ - Create a de-identify template for structured files.
+ - Create image redaction template for images.
+ ```
+ export DLP_DEIDENTIFY_TEMPLATE=YOUR_DEFAULT_DEIDENTIFY_TEMPLATE
+ export DLP_STRUCTURED_DEIDENTIFY_TEMPLATE=YOUR_STRUCTURED_DEIDENTIFY_TEMPLATE
+ export DLP_IMAGE_REDACT_DEIDENTIFY_TEMPLATE=YOUR_IMAGE_REDACT_TEMPLATE
+ ```
+- Copy and paste the data below into a CSV file and [create a BigQuery table](https://cloud.google.com/bigquery/docs/loading-data-local) from the file:
+ ```$xslt
+ Name,TelephoneNumber,Mystery,Age,Gender
+ James,(567) 890-1234,8291 3627 8250 1234,19,Male
+ Gandalf,(223) 456-7890,4231 5555 6781 9876,27,Male
+ Dumbledore,(313) 337-1337,6291 8765 1095 7629,27,Male
+ Joe,(452) 223-1234,3782 2288 1166 3030,35,Male
+ Marie,(452) 223-1234,8291 3627 8250 1234,35,Female
+ Carrie,(567) 890-1234,2253 5218 4251 4526,35,Female
+ ```
+ Set the `DLP_DATASET_ID` and `DLP_TABLE_ID` environment values.
+ ```
+ export DLP_DATASET_ID=YOUR_BIGQUERY_DATASET_ID
+ export DLP_TABLE_ID=YOUR_TABLE_ID
+ ```
+- [Create a Google Cloud Datastore](https://console.cloud.google.com/datastore) kind and add an entity with properties:
+ ```
+ Email : john@doe.com
+ Person Name : John
+ Phone Number : 343-343-3435
+
+ Email : gary@doe.com
+ Person Name : Gary
+ Phone Number : 343-443-3136
+ ```
+ Provide namespace and kind values.
+ - Set the environment variables `DLP_NAMESPACE_ID` and `DLP_DATASTORE_KIND` with the values provided in above step.
+ ```
+ export DLP_NAMESPACE_ID=YOUR_NAMESPACE_ID
+ export DLP_DATASTORE_KIND=YOUR_DATASTORE_KIND
+ ```
+
## Troubleshooting
### bcmath extension missing
diff --git a/dlp/src/inspect_bigquery_send_to_scc.php b/dlp/src/inspect_bigquery_send_to_scc.php
new file mode 100644
index 0000000000..e7b6a3ec54
--- /dev/null
+++ b/dlp/src/inspect_bigquery_send_to_scc.php
@@ -0,0 +1,147 @@
+setProjectId($projectId)
+ ->setDatasetId($datasetId)
+ ->setTableId($tableId);
+ $bigQueryOptions = (new BigQueryOptions())
+ ->setTableReference($bigqueryTable);
+
+ $storageConfig = (new StorageConfig())
+ ->setBigQueryOptions(($bigQueryOptions));
+
+ // Specify the type of info the inspection will look for.
+ $infoTypes = [
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('PERSON_NAME'),
+ (new InfoType())->setName('LOCATION'),
+ (new InfoType())->setName('PHONE_NUMBER')
+ ];
+
+ // Specify how the content should be inspected.
+ $inspectConfig = (new InspectConfig())
+ ->setMinLikelihood(likelihood::UNLIKELY)
+ ->setLimits((new FindingLimits())
+ ->setMaxFindingsPerRequest(100))
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true);
+
+ // Specify the action that is triggered when the job completes.
+ $action = (new Action())
+ ->setPublishSummaryToCscc(new PublishSummaryToCscc());
+
+ // Configure the inspection job we want the service to perform.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Send the job creation request and process the response.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJobConfig
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(10);
+ $job = $dlp->getDlpJob($job->getName());
+ if ($job->getState() == JobState::DONE) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_bigquery_send_to_scc]
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_datastore_send_to_scc.php b/dlp/src/inspect_datastore_send_to_scc.php
new file mode 100644
index 0000000000..4dbb8ab5d8
--- /dev/null
+++ b/dlp/src/inspect_datastore_send_to_scc.php
@@ -0,0 +1,145 @@
+setKind((new KindExpression())
+ ->setName($kindName))
+ ->setPartitionId((new PartitionId())
+ ->setNamespaceId($namespaceId)
+ ->setProjectId($callingProjectId));
+
+ $storageConfig = (new StorageConfig())
+ ->setDatastoreOptions(($datastoreOptions));
+
+ // Specify the type of info the inspection will look for.
+ $infoTypes = [
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('PERSON_NAME'),
+ (new InfoType())->setName('LOCATION'),
+ (new InfoType())->setName('PHONE_NUMBER')
+ ];
+
+ // Specify how the content should be inspected.
+ $inspectConfig = (new InspectConfig())
+ ->setMinLikelihood(likelihood::UNLIKELY)
+ ->setLimits((new FindingLimits())
+ ->setMaxFindingsPerRequest(100))
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true);
+
+ // Specify the action that is triggered when the job completes.
+ $action = (new Action())
+ ->setPublishSummaryToCscc(new PublishSummaryToCscc());
+
+ // Construct inspect job config to run.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Send the job creation request and process the response.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJobConfig
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(10);
+ $job = $dlp->getDlpJob($job->getName());
+ if ($job->getState() == JobState::DONE) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_datastore_send_to_scc]
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_gcs_send_to_scc.php b/dlp/src/inspect_gcs_send_to_scc.php
new file mode 100644
index 0000000000..5c1e830479
--- /dev/null
+++ b/dlp/src/inspect_gcs_send_to_scc.php
@@ -0,0 +1,140 @@
+setFileSet((new FileSet())
+ ->setUrl($gcsUri));
+
+ $storageConfig = (new StorageConfig())
+ ->setCloudStorageOptions(($cloudStorageOptions));
+
+ // Specify the type of info the inspection will look for.
+ $infoTypes = [
+ (new InfoType())->setName('EMAIL_ADDRESS'),
+ (new InfoType())->setName('PERSON_NAME'),
+ (new InfoType())->setName('LOCATION'),
+ (new InfoType())->setName('PHONE_NUMBER')
+ ];
+
+ // Specify how the content should be inspected.
+ $inspectConfig = (new InspectConfig())
+ ->setMinLikelihood(likelihood::UNLIKELY)
+ ->setLimits((new FindingLimits())
+ ->setMaxFindingsPerRequest(100))
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true);
+
+ // Specify the action that is triggered when the job completes.
+ $action = (new Action())
+ ->setPublishSummaryToCscc(new PublishSummaryToCscc());
+
+ // Construct inspect job config to run.
+ $inspectJobConfig = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Send the job creation request and process the response.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJobConfig
+ ]);
+
+ $numOfAttempts = 10;
+ do {
+ printf('Waiting for job to complete' . PHP_EOL);
+ sleep(10);
+ $job = $dlp->getDlpJob($job->getName());
+ if ($job->getState() == JobState::DONE) {
+ break;
+ }
+ $numOfAttempts--;
+ } while ($numOfAttempts > 0);
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_gcs_send_to_scc]
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/inspect_gcs_with_sampling.php b/dlp/src/inspect_gcs_with_sampling.php
new file mode 100644
index 0000000000..173947d32c
--- /dev/null
+++ b/dlp/src/inspect_gcs_with_sampling.php
@@ -0,0 +1,166 @@
+topic($topicId);
+
+ // Construct the items to be inspected.
+ $cloudStorageOptions = (new CloudStorageOptions())
+ ->setFileSet((new FileSet())
+ ->setUrl($gcsUri))
+ ->setBytesLimitPerFile(200)
+ ->setFilesLimitPercent(90)
+ ->setSampleMethod(SampleMethod::RANDOM_START);
+
+ $storageConfig = (new StorageConfig())
+ ->setCloudStorageOptions($cloudStorageOptions);
+
+ // Specify the type of info the inspection will look for.
+ $phoneNumberInfoType = (new InfoType())
+ ->setName('PHONE_NUMBER');
+ $emailAddressInfoType = (new InfoType())
+ ->setName('EMAIL_ADDRESS');
+ $cardNumberInfoType = (new InfoType())
+ ->setName('CREDIT_CARD_NUMBER');
+ $infoTypes = [$phoneNumberInfoType, $emailAddressInfoType, $cardNumberInfoType];
+
+ // Specify how the content should be inspected.
+ $inspectConfig = (new InspectConfig())
+ ->setInfoTypes($infoTypes)
+ ->setIncludeQuote(true);
+
+ // Construct the action to run when job completes.
+ $action = (new Action())
+ ->setPubSub((new PublishToPubSub())
+ ->setTopic($topic->name()));
+
+ // Construct inspect job config to run.
+ $inspectJob = (new InspectJobConfig())
+ ->setInspectConfig($inspectConfig)
+ ->setStorageConfig($storageConfig)
+ ->setActions([$action]);
+
+ // Listen for job notifications via an existing topic/subscription.
+ $subscription = $topic->subscription($subscriptionId);
+
+ // Submit request.
+ $parent = "projects/$callingProjectId/locations/global";
+ $job = $dlp->createDlpJob($parent, [
+ 'inspectJob' => $inspectJob
+ ]);
+
+ // Poll Pub/Sub using exponential backoff until job finishes.
+ // Consider using an asynchronous execution model such as Cloud Functions.
+ $attempt = 1;
+ $startTime = time();
+ do {
+ foreach ($subscription->pull() as $message) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
+ $subscription->acknowledge($message);
+ // Get the updated job. Loop to avoid race condition with DLP API.
+ do {
+ $job = $dlp->getDlpJob($job->getName());
+ } while ($job->getState() == JobState::RUNNING);
+ break 2; // break from parent do while.
+ }
+ }
+ printf('Waiting for job to complete' . PHP_EOL);
+ // Exponential backoff with max delay of 60 seconds.
+ sleep(min(60, pow(2, ++$attempt)));
+ } while (time() - $startTime < 600); // 10 minute timeout.
+
+ // Print finding counts.
+ printf('Job %s status: %s' . PHP_EOL, $job->getName(), JobState::name($job->getState()));
+ switch ($job->getState()) {
+ case JobState::DONE:
+ $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats();
+ if (count($infoTypeStats) === 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ foreach ($infoTypeStats as $infoTypeStat) {
+ printf(
+ ' Found %s instance(s) of infoType %s' . PHP_EOL,
+ $infoTypeStat->getCount(),
+ $infoTypeStat->getInfoType()->getName()
+ );
+ }
+ }
+ break;
+ case JobState::FAILED:
+ printf('Job %s had errors:' . PHP_EOL, $job->getName());
+ $errors = $job->getErrors();
+ foreach ($errors as $error) {
+ var_dump($error->getDetails());
+ }
+ break;
+ case JobState::PENDING:
+ printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ break;
+ default:
+ printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ }
+}
+# [END dlp_inspect_gcs_with_sampling]
+
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index 59921d9365..c839ae6504 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -1416,4 +1416,210 @@ public function testInspectBigQueryWithSampling()
$this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
$this->assertStringContainsString('infoType PERSON_NAME', $output);
}
+
+ public function testInspectGcsWithSampling()
+ {
+ $gcsUri = $this->requireEnv('GCS_PATH');
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ $topicId = self::$topic->name();
+ $subscriptionId = self::$subscription->name();
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic($topicId)
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . $topicId);
+
+ $topicMock->subscription($subscriptionId)
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_gcs_with_sampling('%s','%s','%s','%s');",
+ self::$projectId,
+ $gcsUri,
+ $topicId,
+ $subscriptionId
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_gcs_with_sampling', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ }
+
+ public function testInspectGcsSendToScc()
+ {
+ $gcsPath = $this->requireEnv('GCS_PATH');
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_gcs_send_to_scc('%s','%s');",
+ self::$projectId,
+ $gcsPath
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_gcs_send_to_scc', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ }
+
+ public function testInspectDatastoreSendToScc()
+ {
+ $datastorename = $this->requireEnv('DLP_DATASTORE_KIND');
+ $namespaceId = $this->requireEnv('DLP_NAMESPACE_ID');
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_datastore_send_to_scc('%s','%s','%s');",
+ self::$projectId,
+ $datastorename,
+ $namespaceId
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_datastore_send_to_scc', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ }
+
+ public function testInspectBigquerySendToScc()
+ {
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_bigquery_send_to_scc('%s','%s','%s','%s');",
+ self::$projectId,
+ 'bigquery-public-data',
+ 'usa_names',
+ 'usa_1910_current'
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_bigquery_send_to_scc', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
+ $this->assertStringContainsString('infoType PERSON_NAME', $output);
+ }
}
From b4e44899eb9a3a52472202caac9de6a2704b6ce9 Mon Sep 17 00:00:00 2001
From: minherz
Date: Tue, 12 Sep 2023 15:13:21 +0000
Subject: [PATCH 072/285] fix: update write log sample to setup severity
(#1915)
---
logging/src/write_log.php | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/logging/src/write_log.php b/logging/src/write_log.php
index 889c4a910a..68e2a3e17d 100644
--- a/logging/src/write_log.php
+++ b/logging/src/write_log.php
@@ -19,6 +19,7 @@
// [START logging_write_log_entry]
use Google\Cloud\Logging\LoggingClient;
+use Google\Cloud\Logging\Logger;
/** Write a log message via the Stackdriver Logging API.
*
@@ -37,7 +38,9 @@ function write_log($projectId, $loggerName, $message)
]
]
]);
- $entry = $logger->entry($message);
+ $entry = $logger->entry($message, [
+ 'severity' => Logger::INFO
+ ]);
$logger->write($entry);
printf("Wrote a log to a logger '%s'." . PHP_EOL, $loggerName);
}
From fe53920436169c918e6242bf25eb696832e6dcc1 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 13 Sep 2023 11:35:34 +0530
Subject: [PATCH 073/285] feat(dlp): sample for Stored infoType and Trigger
(#1894)
* Implemented Stored infoType and Trigger
* Removed dlp_delete_stored_infotype region tag
* Resolved
* Applied mocking on stored infotype
* Addressed the review comments
---------
Co-authored-by: Yash Sahu <54198301+yash30201@users.noreply.github.com>
---
dlp/src/create_stored_infotype.php | 90 +++++++++++++++
dlp/src/create_trigger.php | 24 ++--
dlp/src/inspect_with_stored_infotype.php | 93 +++++++++++++++
dlp/src/update_stored_infotype.php | 88 ++++++++++++++
dlp/src/update_trigger.php | 84 ++++++++++++++
dlp/test/data/term-list.txt | 2 +
dlp/test/dlpTest.php | 140 +++++++++++++++++++++++
7 files changed, 509 insertions(+), 12 deletions(-)
create mode 100644 dlp/src/create_stored_infotype.php
create mode 100644 dlp/src/inspect_with_stored_infotype.php
create mode 100644 dlp/src/update_stored_infotype.php
create mode 100644 dlp/src/update_trigger.php
create mode 100644 dlp/test/data/term-list.txt
diff --git a/dlp/src/create_stored_infotype.php b/dlp/src/create_stored_infotype.php
new file mode 100644
index 0000000000..c37853f3ed
--- /dev/null
+++ b/dlp/src/create_stored_infotype.php
@@ -0,0 +1,90 @@
+setTable((new BigQueryTable())
+ ->setDatasetId('samples')
+ ->setProjectId('bigquery-public-data')
+ ->setTableId('github_nested'))
+ ->setField((new FieldId())
+ ->setName('actor'));
+
+ $largeCustomDictionaryConfig = (new LargeCustomDictionaryConfig())
+ // The output path where the custom dictionary containing the GitHub usernames will be stored.
+ ->setOutputPath((new CloudStoragePath())
+ ->setPath($outputgcsPath))
+ ->setBigQueryField($bigQueryField);
+
+ // Configure the StoredInfoType we want the service to perform.
+ $storedInfoTypeConfig = (new StoredInfoTypeConfig())
+ ->setDisplayName($displayName)
+ ->setDescription($description)
+ ->setLargeCustomDictionary($largeCustomDictionaryConfig);
+
+ // Send the stored infoType creation request and process the response.
+ $parent = "projects/$callingProjectId/locations/global";
+ $response = $dlp->createStoredInfoType($parent, $storedInfoTypeConfig, [
+ 'storedInfoTypeId' => $storedInfoTypeId
+ ]);
+
+ // Print results.
+ printf('Successfully created Stored InfoType : %s', $response->getName());
+}
+# [END dlp_create_stored_infotype]
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/create_trigger.php b/dlp/src/create_trigger.php
index a01bc4afd4..cbbc0e2612 100644
--- a/dlp/src/create_trigger.php
+++ b/dlp/src/create_trigger.php
@@ -1,5 +1,4 @@
setSchedule($schedule);
// Create the storageConfig object
- $fileSet = (new CloudStorageOptions_FileSet())
+ $fileSet = (new FileSet())
->setUrl('gs://' . $bucketName . '/*');
$storageOptions = (new CloudStorageOptions())
->setFileSet($fileSet);
// Auto-populate start and end times in order to scan new objects only.
- $timespanConfig = (new StorageConfig_TimespanConfig())
+ $timespanConfig = (new TimespanConfig())
->setEnableAutoPopulationOfTimespanConfig($autoPopulateTimespan);
$storageConfig = (new StorageConfig())
@@ -126,7 +125,8 @@ function create_trigger(
->setDescription($description);
// Run trigger creation request
- $parent = "projects/$callingProjectId/locations/global";
+ // $parent = "projects/$callingProjectId/locations/global";
+ $parent = $dlp->locationName($callingProjectId, 'global');
$trigger = $dlp->createJobTrigger($parent, $jobTriggerObject, [
'triggerId' => $triggerId
]);
diff --git a/dlp/src/inspect_with_stored_infotype.php b/dlp/src/inspect_with_stored_infotype.php
new file mode 100644
index 0000000000..d73770bbbb
--- /dev/null
+++ b/dlp/src/inspect_with_stored_infotype.php
@@ -0,0 +1,93 @@
+setValue($textToInspect);
+
+ // Reference to the existing StoredInfoType to inspect the data.
+ $customInfoType = (new CustomInfoType())
+ ->setInfoType((new InfoType())
+ ->setName('STORED_TYPE'))
+ ->setStoredType((new StoredType())
+ ->setName($storedInfoTypeName));
+
+ // Construct the configuration for the Inspect request.
+ $inspectConfig = (new InspectConfig())
+ ->setCustomInfoTypes([$customInfoType])
+ ->setIncludeQuote(true);
+
+ // Run request.
+ $response = $dlp->inspectContent([
+ 'parent' => $parent,
+ 'inspectConfig' => $inspectConfig,
+ 'item' => $item
+ ]);
+
+ // Print the results.
+ $findings = $response->getResult()->getFindings();
+ if (count($findings) == 0) {
+ printf('No findings.' . PHP_EOL);
+ } else {
+ printf('Findings:' . PHP_EOL);
+ foreach ($findings as $finding) {
+ printf(' Quote: %s' . PHP_EOL, $finding->getQuote());
+ printf(' Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
+ printf(' Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
+ }
+ }
+}
+# [END dlp_inspect_with_stored_infotype]
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/update_stored_infotype.php b/dlp/src/update_stored_infotype.php
new file mode 100644
index 0000000000..22ee174315
--- /dev/null
+++ b/dlp/src/update_stored_infotype.php
@@ -0,0 +1,88 @@
+setUrl($gcsPath);
+
+ // Configuration for a custom dictionary created from a data source of any size
+ $largeCustomDictionaryConfig = (new LargeCustomDictionaryConfig())
+ ->setOutputPath((new CloudStoragePath())
+ ->setPath($outputgcsPath))
+ ->setCloudStorageFileSet($cloudStorageFileSet);
+
+ // Set configuration for stored infoTypes.
+ $storedInfoTypeConfig = (new StoredInfoTypeConfig())
+ ->setLargeCustomDictionary($largeCustomDictionaryConfig);
+
+ // Send the stored infoType creation request and process the response.
+
+ $name = "projects/$callingProjectId/locations/global/storedInfoTypes/" . $storedInfoTypeId;
+ // Set mask to control which fields get updated.
+ // Refer https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for constructing the field mask paths.
+ $fieldMask = (new FieldMask())
+ ->setPaths([
+ 'large_custom_dictionary.cloud_storage_file_set.url'
+ ]);
+
+ // Run request
+ $response = $dlp->updateStoredInfoType($name, [
+ 'config' => $storedInfoTypeConfig,
+ 'updateMask' => $fieldMask
+ ]);
+
+ // Print results
+ printf('Successfully update Stored InforType : %s' . PHP_EOL, $response->getName());
+}
+# [END dlp_update_stored_infotype]
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/src/update_trigger.php b/dlp/src/update_trigger.php
new file mode 100644
index 0000000000..9a3adc1f8e
--- /dev/null
+++ b/dlp/src/update_trigger.php
@@ -0,0 +1,84 @@
+setInfoTypes([
+ (new InfoType())
+ ->setName('US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER')
+ ])
+ ->setMinLikelihood(Likelihood::LIKELY);
+
+ // Configure the Job Trigger we want the service to perform.
+ $jobTrigger = (new JobTrigger())
+ ->setInspectJob((new InspectJobConfig())
+ ->setInspectConfig($inspectConfig));
+
+ // Specify fields of the jobTrigger resource to be updated when the job trigger is modified.
+ // Refer https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for constructing the field mask paths.
+ $fieldMask = (new FieldMask())
+ ->setPaths([
+ 'inspect_job.inspect_config.info_types',
+ 'inspect_job.inspect_config.min_likelihood'
+ ]);
+
+ // Send the update job trigger request and process the response.
+ $name = "projects/$callingProjectId/locations/global/jobTriggers/" . $jobTriggerName;
+
+ $response = $dlp->updateJobTrigger($name, [
+ 'jobTrigger' => $jobTrigger,
+ 'updateMask' => $fieldMask
+ ]);
+
+ // Print results.
+ printf('Successfully update trigger %s' . PHP_EOL, $response->getName());
+}
+# [END dlp_update_trigger]
+// The following 2 lines are only needed to run the samples.
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/dlp/test/data/term-list.txt b/dlp/test/data/term-list.txt
new file mode 100644
index 0000000000..e5f7fb187c
--- /dev/null
+++ b/dlp/test/data/term-list.txt
@@ -0,0 +1,2 @@
+test@gmail.com
+gary@example.com
\ No newline at end of file
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index c839ae6504..a7275bb875 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -26,8 +26,10 @@
use Prophecy\PhpUnit\ProphecyTrait;
use PHPUnitRetry\RetryTrait;
use Google\Cloud\Dlp\V2\DlpServiceClient;
+use Google\Cloud\Dlp\V2\Finding;
use Google\Cloud\Dlp\V2\InfoType;
use Google\Cloud\Dlp\V2\InfoTypeStats;
+use Google\Cloud\Dlp\V2\InspectContentResponse;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
use Google\Cloud\PubSub\Message;
@@ -43,11 +45,16 @@
use Google\Cloud\Dlp\V2\HybridOptions;
use Google\Cloud\Dlp\V2\InspectConfig;
use Google\Cloud\Dlp\V2\InspectJobConfig;
+use Google\Cloud\Dlp\V2\InspectResult;
use Google\Cloud\Dlp\V2\JobTrigger;
use Google\Cloud\Dlp\V2\JobTrigger\Status;
use Google\Cloud\Dlp\V2\JobTrigger\Trigger;
+use Google\Cloud\Dlp\V2\Likelihood;
use Google\Cloud\Dlp\V2\Manual;
use Google\Cloud\Dlp\V2\StorageConfig;
+use Google\Cloud\Dlp\V2\StoredInfoType;
+use Google\Cloud\Dlp\V2\StoredInfoTypeState;
+use Google\Cloud\Dlp\V2\StoredInfoTypeVersion;
/**
* Unit Tests for dlp commands.
@@ -266,6 +273,7 @@ public function testTriggers()
$triggerId = uniqid('my-php-test-trigger-');
$scanPeriod = 1;
$autoPopulateTimespan = true;
+ $maxFindings = 10;
$output = $this->runFunctionSnippet('create_trigger', [
self::$projectId,
@@ -275,6 +283,7 @@ public function testTriggers()
$description,
$scanPeriod,
$autoPopulateTimespan,
+ $maxFindings
]);
$fullTriggerId = sprintf('projects/%s/locations/global/jobTriggers/%s', self::$projectId, $triggerId);
$this->assertStringContainsString('Successfully created trigger ' . $fullTriggerId, $output);
@@ -285,6 +294,12 @@ public function testTriggers()
$this->assertStringContainsString('Description: ' . $description, $output);
$this->assertStringContainsString('Auto-populates timespan config: yes', $output);
+ $updateOutput = $this->runFunctionSnippet('update_trigger', [
+ self::$projectId,
+ $triggerId
+ ]);
+ $this->assertStringContainsString('Successfully update trigger ' . $fullTriggerId, $updateOutput);
+
$output = $this->runFunctionSnippet('delete_trigger', [
self::$projectId,
$triggerId
@@ -1622,4 +1637,129 @@ public function testInspectBigquerySendToScc()
$this->assertStringContainsString('projects/' . self::$projectId . '/dlpJobs', $output);
$this->assertStringContainsString('infoType PERSON_NAME', $output);
}
+
+ public function testStoredInfotype()
+ {
+ $bucketName = $this->requireEnv('GOOGLE_STORAGE_BUCKET');
+ $outputgcsPath = 'gs://' . $bucketName;
+ $storedInfoTypeId = uniqid('github-usernames-');
+ $gcsPath = 'gs://' . $bucketName . '/term-list.txt';
+ // Optionally set a display name and a description.
+ $description = 'Dictionary of GitHub usernames used in commits';
+ $displayName = 'GitHub usernames';
+
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock1 = $this->prophesize(DlpServiceClient::class);
+
+ $createStoredInfoTypeResponse = (new StoredInfoType())
+ ->setName('projects/' . self::$projectId . '/locations/global/storedInfoTypes/' . $storedInfoTypeId)
+ ->setCurrentVersion((new StoredInfoTypeVersion())
+ ->setState(StoredInfoTypeState::READY)
+ );
+
+ $inspectContentResponse = (new InspectContentResponse())
+ ->setResult((new InspectResult())
+ ->setFindings([
+ (new Finding())
+ ->setQuote('The')
+ ->setInfoType((new InfoType())->setName('STORED_TYPE'))
+ ->setLikelihood(Likelihood::VERY_LIKELY)
+ ]));
+
+ $dlpServiceClientMock1->createStoredInfoType(Argument::any(), Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createStoredInfoTypeResponse);
+
+ $dlpServiceClientMock1->inspectContent(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($inspectContentResponse);
+
+ $dlpServiceClientMock1->updateStoredInfoType(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createStoredInfoTypeResponse);
+
+ // Test create stored infotype.
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_create_stored_infotype('%s','%s','%s','%s','%s');",
+ self::$projectId,
+ $outputgcsPath,
+ $storedInfoTypeId,
+ $displayName,
+ $description
+ );
+
+ $tmpFile1 = $this->writeTempSample('create_stored_infotype', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock1->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile1;
+ $output = ob_get_clean();
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/locations/global/storedInfoTypes/', $output);
+ $storedInfoTypeName = explode('Successfully created Stored InfoType : ', $output)[1];
+
+ // Test inspect stored infotype.
+ // Creating a temp file for testing.
+ $textToInspect = 'The commit was made by test@gmail.com.';
+
+ $callFunction = sprintf(
+ "dlp_inspect_with_stored_infotype('%s','%s','%s');",
+ self::$projectId,
+ $storedInfoTypeName,
+ $textToInspect
+ );
+
+ $tmpFile2 = $this->writeTempSample('inspect_with_stored_infotype', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+ global $dlp;
+
+ $dlp = $dlpServiceClientMock1->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile2;
+ $inspectOutput = ob_get_clean();
+
+ $this->assertStringContainsString('Quote: The', $inspectOutput);
+ $this->assertStringContainsString('Info type: STORED_TYPE', $inspectOutput);
+ $this->assertStringContainsString('Likelihood: VERY_LIKELY', $inspectOutput);
+
+ // Test update stored infotype.
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_update_stored_infotype('%s','%s','%s','%s');",
+ self::$projectId,
+ $gcsPath,
+ $outputgcsPath,
+ $storedInfoTypeId
+ );
+
+ $tmpFile3 = $this->writeTempSample('update_stored_infotype', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
+ ]);
+
+ global $dlp;
+ $dlp = $dlpServiceClientMock1->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile3;
+ $updateOutput = ob_get_clean();
+
+ $this->assertStringContainsString('projects/' . self::$projectId . '/locations/global/storedInfoTypes/' . $storedInfoTypeId, $updateOutput);
+ }
}
From f45f710099e64ec40455be8dc82dfdd04dde3cf5 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Mon, 18 Sep 2023 18:14:30 +0530
Subject: [PATCH 074/285] test(dlp): Implemented mocking approach in an
existing unit test case (#1906)
* Implemented mocking approach in existing unit test case
---
dlp/src/categorical_stats.php | 21 +-
dlp/src/inspect_bigquery.php | 7 +-
dlp/src/inspect_datastore.php | 11 +-
dlp/src/inspect_gcs.php | 10 +-
dlp/src/k_anonymity.php | 21 +-
dlp/src/k_map.php | 19 +-
dlp/src/l_diversity.php | 23 +-
dlp/src/numerical_stats.php | 19 +-
dlp/test/dlpLongRunningTest.php | 698 +++++++++++++++++++++++++++++++-
dlp/test/dlpTest.php | 58 +--
10 files changed, 754 insertions(+), 133 deletions(-)
diff --git a/dlp/src/categorical_stats.php b/dlp/src/categorical_stats.php
index c95e7c2c14..3533cd5fa2 100644
--- a/dlp/src/categorical_stats.php
+++ b/dlp/src/categorical_stats.php
@@ -1,5 +1,4 @@
$callingProjectId,
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId,
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// Construct risk analysis config
@@ -109,8 +104,10 @@ function categorical_stats(
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -119,7 +116,7 @@ function categorical_stats(
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -156,10 +153,10 @@ function categorical_stats(
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
- printf('Unexpected job state.');
+ print('Unexpected job state.');
}
}
# [END dlp_categorical_stats]
diff --git a/dlp/src/inspect_bigquery.php b/dlp/src/inspect_bigquery.php
index 8381b2bb8c..e54f386ebb 100644
--- a/dlp/src/inspect_bigquery.php
+++ b/dlp/src/inspect_bigquery.php
@@ -1,5 +1,4 @@
pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -139,7 +140,7 @@ function inspect_datastore(
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -165,7 +166,7 @@ function inspect_datastore(
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
print('Unexpected job state.');
diff --git a/dlp/src/inspect_gcs.php b/dlp/src/inspect_gcs.php
index 59930d8e32..73fad59b24 100644
--- a/dlp/src/inspect_gcs.php
+++ b/dlp/src/inspect_gcs.php
@@ -119,8 +119,10 @@ function inspect_gcs(
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -129,7 +131,7 @@ function inspect_gcs(
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -155,7 +157,7 @@ function inspect_gcs(
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
print('Unexpected job state. Most likely, the job is either running or has not yet started.');
diff --git a/dlp/src/k_anonymity.php b/dlp/src/k_anonymity.php
index 1b00f83c52..449ad3a7e7 100644
--- a/dlp/src/k_anonymity.php
+++ b/dlp/src/k_anonymity.php
@@ -1,5 +1,4 @@
$callingProjectId,
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId,
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// Construct risk analysis config
@@ -113,8 +108,10 @@ function ($id) {
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -123,7 +120,7 @@ function ($id) {
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -166,10 +163,10 @@ function ($id) {
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
- printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ print('Unexpected job state. Most likely, the job is either running or has not yet started.');
}
}
# [END dlp_k_anomymity]
diff --git a/dlp/src/k_map.php b/dlp/src/k_map.php
index efb37fd654..61a515b404 100644
--- a/dlp/src/k_map.php
+++ b/dlp/src/k_map.php
@@ -1,5 +1,4 @@
$callingProjectId,
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId,
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// Verify input
@@ -134,8 +129,10 @@ function k_map(
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -144,7 +141,7 @@ function k_map(
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -188,7 +185,7 @@ function k_map(
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
print('Unexpected job state. Most likely, the job is either running or has not yet started.');
diff --git a/dlp/src/l_diversity.php b/dlp/src/l_diversity.php
index 6bdcf5a176..95a4ef2f6a 100644
--- a/dlp/src/l_diversity.php
+++ b/dlp/src/l_diversity.php
@@ -1,5 +1,4 @@
$callingProjectId,
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId,
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// Construct risk analysis config
@@ -119,8 +114,10 @@ function ($id) {
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -129,7 +126,7 @@ function ($id) {
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -182,10 +179,10 @@ function ($id) {
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
- printf('Unexpected job state. Most likely, the job is either running or has not yet started.');
+ print('Unexpected job state. Most likely, the job is either running or has not yet started.');
}
}
# [END dlp_l_diversity]
diff --git a/dlp/src/numerical_stats.php b/dlp/src/numerical_stats.php
index 2559f9fd64..2dbb1e3327 100644
--- a/dlp/src/numerical_stats.php
+++ b/dlp/src/numerical_stats.php
@@ -1,5 +1,4 @@
$callingProjectId
- ]);
- $pubsub = new PubSubClient([
- 'projectId' => $callingProjectId
- ]);
+ $dlp = new DlpServiceClient();
+ $pubsub = new PubSubClient();
$topic = $pubsub->topic($topicId);
// Construct risk analysis config
@@ -109,8 +104,10 @@ function numerical_stats(
$startTime = time();
do {
foreach ($subscription->pull() as $message) {
- if (isset($message->attributes()['DlpJobName']) &&
- $message->attributes()['DlpJobName'] === $job->getName()) {
+ if (
+ isset($message->attributes()['DlpJobName']) &&
+ $message->attributes()['DlpJobName'] === $job->getName()
+ ) {
$subscription->acknowledge($message);
// Get the updated job. Loop to avoid race condition with DLP API.
do {
@@ -119,7 +116,7 @@ function numerical_stats(
break 2; // break from parent do while
}
}
- printf('Waiting for job to complete' . PHP_EOL);
+ print('Waiting for job to complete' . PHP_EOL);
// Exponential backoff with max delay of 60 seconds
sleep(min(60, pow(2, ++$attempt)));
} while (time() - $startTime < 600); // 10 minute timeout
@@ -160,7 +157,7 @@ function numerical_stats(
}
break;
case JobState::PENDING:
- printf('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
+ print('Job has not completed. Consider a longer timeout or an asynchronous execution model' . PHP_EOL);
break;
default:
print('Unexpected job state. Most likely, the job is either running or has not yet started.');
diff --git a/dlp/test/dlpLongRunningTest.php b/dlp/test/dlpLongRunningTest.php
index 3f32563a18..e8e0cd9953 100644
--- a/dlp/test/dlpLongRunningTest.php
+++ b/dlp/test/dlpLongRunningTest.php
@@ -28,7 +28,22 @@
use Google\Cloud\Dlp\V2\InfoType;
use Google\Cloud\Dlp\V2\InfoTypeStats;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\CategoricalStatsResult;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\CategoricalStatsResult\CategoricalStatsHistogramBucket;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult\KAnonymityEquivalenceClass;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KAnonymityResult\KAnonymityHistogramBucket;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KMapEstimationResult;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KMapEstimationResult\KMapEstimationHistogramBucket;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\KMapEstimationResult\KMapEstimationQuasiIdValues;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\LDiversityResult;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\LDiversityResult\LDiversityEquivalenceClass;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\LDiversityResult\LDiversityHistogramBucket;
+use Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails\NumericalStatsResult;
use Google\Cloud\Dlp\V2\InspectDataSourceDetails\Result;
+use Google\Cloud\Dlp\V2\Value;
+use Google\Cloud\Dlp\V2\ValueFrequency;
use Google\Cloud\PubSub\Message;
use Google\Cloud\PubSub\PubSubClient;
use Google\Cloud\PubSub\Subscription;
@@ -109,27 +124,155 @@ public function testInspectDatastore()
$kind = 'Person';
$namespace = 'DLP';
- $output = $this->runFunctionSnippet('inspect_datastore', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_datastore('%s','%s','%s','%s','%s','%s');",
self::$projectId,
self::$projectId,
self::$topic->name(),
self::$subscription->name(),
$kind,
$namespace
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_datastore', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
$this->assertStringContainsString('PERSON_NAME', $output);
}
public function testInspectBigquery()
{
- $output = $this->runFunctionSnippet('inspect_bigquery', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $dlpJobResponse = $this->dlpJobResponse();
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['createDlpJob']);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($dlpJobResponse['getDlpJob']);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_inspect_bigquery('%s','%s','%s','%s','%s','%s');",
self::$projectId,
self::$projectId,
self::$topic->name(),
self::$subscription->name(),
self::$dataset,
self::$table,
+ );
+
+ $tmpFile = $this->writeTempSample('inspect_bigquery', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
$this->assertStringContainsString('PERSON_NAME', $output);
}
@@ -218,7 +361,75 @@ public function testNumericalStats()
{
$columnName = 'Age';
- $output = $this->runFunctionSnippet('numerical_stats', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setNumericalStatsResult((new NumericalStatsResult())
+ ->setMinValue((new Value())->setIntegerValue(1231))
+ ->setMaxValue((new Value())->setIntegerValue(9999))
+ ->setQuantileValues([
+ (new Value())->setIntegerValue(1231),
+ (new Value())->setIntegerValue(1231),
+ (new Value())->setIntegerValue(1231),
+ (new Value())->setIntegerValue(1234),
+ (new Value())->setIntegerValue(1234),
+ (new Value())->setIntegerValue(3412),
+ (new Value())->setIntegerValue(3412),
+ (new Value())->setIntegerValue(4444),
+ (new Value())->setIntegerValue(9999),
+ ])
+ )
+ );
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_numerical_stats('%s','%s','%s','%s','%s','%s','%s');",
self::$projectId, // calling project
self::$projectId, // data project
self::$topic->name(),
@@ -226,8 +437,26 @@ public function testNumericalStats()
self::$dataset,
self::$table,
$columnName,
+ );
+
+ $tmpFile = $this->writeTempSample('numerical_stats', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
$this->assertMatchesRegularExpression('/Value range: \[\d+, \d+\]/', $output);
$this->assertMatchesRegularExpression('/Value at \d+ quantile: \d+/', $output);
}
@@ -236,7 +465,73 @@ public function testCategoricalStats()
{
$columnName = 'Gender';
- $output = $this->runFunctionSnippet('categorical_stats', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setCategoricalStatsResult((new CategoricalStatsResult())
+ ->setValueFrequencyHistogramBuckets([
+ (new CategoricalStatsHistogramBucket())
+ ->setValueFrequencyUpperBound(1)
+ ->setValueFrequencyLowerBound(1)
+ ->setBucketSize(1)
+ ->setBucketValues([
+ (new ValueFrequency())
+ ->setValue((new Value())->setStringValue('{"stringValue":"19"}'))
+ ->setCount(1),
+ ]),
+ ])
+ )
+ );
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_categorical_stats('%s','%s','%s','%s','%s','%s','%s');",
self::$projectId, // calling project
self::$projectId, // data project
self::$topic->name(),
@@ -244,8 +539,26 @@ public function testCategoricalStats()
self::$dataset,
self::$table,
$columnName,
+ );
+
+ $tmpFile = $this->writeTempSample('categorical_stats', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+ // Assert the expected behavior or outcome
$this->assertMatchesRegularExpression('/Most common value occurs \d+ time\(s\)/', $output);
$this->assertMatchesRegularExpression('/Least common value occurs \d+ time\(s\)/', $output);
$this->assertMatchesRegularExpression('/\d+ unique value\(s\) total/', $output);
@@ -253,27 +566,246 @@ public function testCategoricalStats()
public function testKAnonymity()
{
- $quasiIds = 'Age,Gender';
- $output = $this->runFunctionSnippet('k_anonymity', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setKAnonymityResult((new KAnonymityResult())
+ ->setEquivalenceClassHistogramBuckets([
+ (new KAnonymityHistogramBucket())
+ ->setEquivalenceClassSizeLowerBound(1)
+ ->setEquivalenceClassSizeUpperBound(1)
+ ->setBucketValues([
+ (new KAnonymityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"19"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEquivalenceClassSize(1),
+ (new KAnonymityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEquivalenceClassSize(1)
+
+ ]),
+ (new KAnonymityHistogramBucket())
+ ->setEquivalenceClassSizeLowerBound(2)
+ ->setEquivalenceClassSizeUpperBound(2)
+ ->setBucketValues([
+ (new KAnonymityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Female"}')
+ ])
+ ->setEquivalenceClassSize(2)
+ ])
+ ])
+ )
+ );
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_k_anonymity('%s','%s','%s','%s','%s','%s',%s);",
self::$projectId, // calling project
self::$projectId, // data project
self::$topic->name(),
self::$subscription->name(),
self::$dataset,
self::$table,
- $quasiIds,
+ "['Age', 'Mystery']"
+ );
+
+ $tmpFile = $this->writeTempSample('k_anonymity', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
- $this->assertStringContainsString('{"stringValue":"Female"}', $output);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('Job projects/' . self::$projectId . '/dlpJobs/', $output);
+ $this->assertStringContainsString('{\"stringValue\":\"Female\"}', $output);
$this->assertMatchesRegularExpression('/Class size: \d/', $output);
}
public function testLDiversity()
{
$sensitiveAttribute = 'Name';
- $quasiIds = 'Age,Gender';
- $output = $this->runFunctionSnippet('l_diversity', [
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setLDiversityResult((new LDiversityResult())
+ ->setSensitiveValueFrequencyHistogramBuckets([
+ (new LDiversityHistogramBucket())
+ ->setSensitiveValueFrequencyLowerBound(1)
+ ->setSensitiveValueFrequencyUpperBound(1)
+ ->setBucketValues([
+ (new LDiversityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"19"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEquivalenceClassSize(1)
+ ->setTopSensitiveValues([
+ (new ValueFrequency())
+ ->setValue((new Value())->setStringValue('{"stringValue":"James"}'))
+ ->setCount(1)
+ ]),
+ (new LDiversityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEquivalenceClassSize(1)
+ ->setTopSensitiveValues([
+ (new ValueFrequency())
+ ->setValue((new Value())->setStringValue('{"stringValue":"Joe"}'))
+ ->setCount(1)
+ ]),
+ ]),
+ (new LDiversityHistogramBucket())
+ ->setSensitiveValueFrequencyLowerBound(2)
+ ->setSensitiveValueFrequencyUpperBound(2)
+ ->setBucketValues([
+ (new LDiversityEquivalenceClass())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"stringValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Female"}')
+ ])
+ ->setEquivalenceClassSize(1)
+ ->setTopSensitiveValues([
+ (new ValueFrequency())
+ ->setValue((new Value())->setStringValue('{"stringValue":"Carrie"}'))
+ ->setCount(2),
+ (new ValueFrequency())
+ ->setValue((new Value())->setStringValue('{"stringValue":"Marie"}'))
+ ->setCount(1)
+ ]),
+ ]),
+ ])
+ )
+ );
+
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_l_diversity('%s','%s','%s','%s','%s','%s','%s',%s);",
self::$projectId, // calling project
self::$projectId, // data project
self::$topic->name(),
@@ -281,20 +813,129 @@ public function testLDiversity()
self::$dataset,
self::$table,
$sensitiveAttribute,
- $quasiIds,
+ "['Age', 'Gender']"
+ );
+
+ $tmpFile = $this->writeTempSample('l_diversity', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
- $this->assertStringContainsString('{"stringValue":"Female"}', $output);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
+ $this->assertStringContainsString('{\"stringValue\":\"Female\"}', $output);
$this->assertMatchesRegularExpression('/Class size: \d/', $output);
- $this->assertStringContainsString('{"stringValue":"James"}', $output);
+ $this->assertStringContainsString('{\"stringValue\":\"James\"}', $output);
}
public function testKMap()
{
$regionCode = 'US';
- $quasiIds = 'Age,Gender';
- $infoTypes = 'AGE,GENDER';
+ // Mock the necessary objects and methods
+ $dlpServiceClientMock = $this->prophesize(DlpServiceClient::class);
+
+ $createDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::PENDING);
+
+ $getDlpJobResponse = (new DlpJob())
+ ->setName('projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812')
+ ->setState(JobState::DONE)
+ ->setRiskDetails((new AnalyzeDataSourceRiskDetails())
+ ->setKMapEstimationResult((new KMapEstimationResult())
+ ->setKMapEstimationHistogram([
+ (new KMapEstimationHistogramBucket())
+ ->setMinAnonymity(3)
+ ->setMaxAnonymity(3)
+ ->setBucketSize(3)
+ ->setBucketValues([
+ (new KMapEstimationQuasiIdValues())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"integerValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Female"}')
+ ])
+ ->setEstimatedAnonymity(3),
+ ]),
+ (new KMapEstimationHistogramBucket())
+ ->setMinAnonymity(1)
+ ->setMaxAnonymity(1)
+ ->setBucketSize(2)
+ ->setBucketValues([
+ (new KMapEstimationQuasiIdValues())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"integerValue":"19"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEstimatedAnonymity(1),
+ (new KMapEstimationQuasiIdValues())
+ ->setQuasiIdsValues([
+ (new Value())
+ ->setStringValue('{"integerValue":"35"}'),
+ (new Value())
+ ->setStringValue('{"stringValue":"Male"}')
+ ])
+ ->setEstimatedAnonymity(1),
+ ]),
+ ])
+ )
+ );
- $output = $this->runFunctionSnippet('k_map', [
+ $dlpServiceClientMock->createDlpJob(Argument::any(), Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($createDlpJobResponse);
+
+ $dlpServiceClientMock->getDlpJob(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($getDlpJobResponse);
+
+ $pubSubClientMock = $this->prophesize(PubSubClient::class);
+ $topicMock = $this->prophesize(Topic::class);
+ $subscriptionMock = $this->prophesize(Subscription::class);
+ $messageMock = $this->prophesize(Message::class);
+
+ // Set up the mock expectations for the Pub/Sub functions
+ $pubSubClientMock->topic(self::$topic->name())
+ ->shouldBeCalled()
+ ->willReturn($topicMock->reveal());
+
+ $topicMock->name()
+ ->shouldBeCalled()
+ ->willReturn('projects/' . self::$projectId . '/topics/' . self::$topic->name());
+
+ $topicMock->subscription(self::$subscription->name())
+ ->shouldBeCalled()
+ ->willReturn($subscriptionMock->reveal());
+
+ $subscriptionMock->pull()
+ ->shouldBeCalled()
+ ->willReturn([$messageMock->reveal()]);
+
+ $messageMock->attributes()
+ ->shouldBeCalledTimes(2)
+ ->willReturn(['DlpJobName' => 'projects/' . self::$projectId . '/dlpJobs/i-3208317104051988812']);
+
+ $subscriptionMock->acknowledge(Argument::any())
+ ->shouldBeCalled()
+ ->willReturn($messageMock->reveal());
+
+ // Creating a temp file for testing.
+ $callFunction = sprintf(
+ "dlp_k_map('%s','%s','%s','%s','%s','%s','%s',%s,%s);",
self::$projectId,
self::$projectId,
self::$topic->name(),
@@ -302,11 +943,30 @@ public function testKMap()
self::$dataset,
self::$table,
$regionCode,
- $quasiIds,
- $infoTypes,
+ "['Age','Gender']",
+ "['AGE','GENDER']",
+ );
+
+ $tmpFile = $this->writeTempSample('k_map', [
+ '$dlp = new DlpServiceClient();' => 'global $dlp;',
+ '$pubsub = new PubSubClient();' => 'global $pubsub;',
+ "require_once __DIR__ . '/../../testing/sample_helpers.php';" => '',
+ '\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);' => $callFunction
]);
+ global $dlp;
+ global $pubsub;
+
+ $dlp = $dlpServiceClientMock->reveal();
+ $pubsub = $pubSubClientMock->reveal();
+
+ // Invoke file and capture output
+ ob_start();
+ include $tmpFile;
+ $output = ob_get_clean();
+
+ // Assert the expected behavior or outcome
$this->assertMatchesRegularExpression('/Anonymity range: \[\d, \d\]/', $output);
$this->assertMatchesRegularExpression('/Size: \d/', $output);
- $this->assertStringContainsString('{"stringValue":"Female"}', $output);
+ $this->assertStringContainsString('{\"stringValue\":\"Female\"}', $output);
}
}
diff --git a/dlp/test/dlpTest.php b/dlp/test/dlpTest.php
index a7275bb875..c682660f09 100644
--- a/dlp/test/dlpTest.php
+++ b/dlp/test/dlpTest.php
@@ -339,22 +339,34 @@ public function testInspectTemplates()
*/
public function testJobs()
{
+ $gcsPath = $this->requireEnv('GCS_PATH');
+ $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
// Set filter to only go back a day, so that we do not pull every job.
$filter = sprintf(
'state=DONE AND end_time>"%sT00:00:00+00:00"',
date('Y-m-d', strtotime('-1 day'))
);
- $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
- $output = $this->runFunctionSnippet('list_jobs', [
+ $jobName = $this->runFunctionSnippet('create_job', [
+ self::$projectId,
+ $gcsPath
+ ]);
+ $this->assertMatchesRegularExpression($jobIdRegex, $jobName);
+
+ $listOutput = $this->runFunctionSnippet('list_jobs', [
self::$projectId,
$filter,
]);
- $this->assertMatchesRegularExpression($jobIdRegex, $output);
- preg_match($jobIdRegex, $output, $jobIds);
+ $this->assertMatchesRegularExpression($jobIdRegex, $listOutput);
+ preg_match($jobIdRegex, $listOutput, $jobIds);
$jobId = $jobIds[0];
+ $getJobOutput = $this->runFunctionSnippet('get_job', [
+ $jobId
+ ]);
+ $this->assertStringContainsString('Job ' . $jobId . ' status:', $getJobOutput);
+
$output = $this->runFunctionSnippet(
'delete_job',
[$jobId]
@@ -875,44 +887,6 @@ public function testDeidReidTextFPE()
$this->assertEquals($string, $reidOutput);
}
- public function testGetJob()
- {
-
- // Set filter to only go back a day, so that we do not pull every job.
- $filter = sprintf(
- 'state=DONE AND end_time>"%sT00:00:00+00:00"',
- date('Y-m-d', strtotime('-1 day'))
- );
- $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
- $getJobName = $this->runFunctionSnippet('list_jobs', [
- self::$projectId,
- $filter,
- ]);
- preg_match($jobIdRegex, $getJobName, $jobIds);
- $jobName = $jobIds[0];
-
- $output = $this->runFunctionSnippet('get_job', [
- $jobName
- ]);
- $this->assertStringContainsString('Job ' . $jobName . ' status:', $output);
- }
-
- public function testCreateJob()
- {
- $gcsPath = $this->requireEnv('GCS_PATH');
- $jobIdRegex = "~projects/.*/dlpJobs/i-\d+~";
- $jobName = $this->runFunctionSnippet('create_job', [
- self::$projectId,
- $gcsPath
- ]);
- $this->assertRegExp($jobIdRegex, $jobName);
- $output = $this->runFunctionSnippet(
- 'delete_job',
- [$jobName]
- );
- $this->assertStringContainsString('Successfully deleted job ' . $jobName, $output);
- }
-
public function testRedactImageListedInfotypes()
{
$imagePath = __DIR__ . '/data/test.png';
From 7f4be92568d05633457fc403a9a953b796dec151 Mon Sep 17 00:00:00 2001
From: minherz
Date: Thu, 21 Sep 2023 22:26:07 +0000
Subject: [PATCH 075/285] chore: refactor error reporting code sample (#1917)
---
error_reporting/quickstart.php | 4 ++--
error_reporting/test/quickstartTest.php | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/error_reporting/quickstart.php b/error_reporting/quickstart.php
index 6704ea00c0..06144dd550 100644
--- a/error_reporting/quickstart.php
+++ b/error_reporting/quickstart.php
@@ -11,7 +11,7 @@
// These variables are set by the App Engine environment. To test locally,
// ensure these are set or manually change their values.
-$projectId = getenv('GCLOUD_PROJECT') ?: 'YOUR_PROJECT_ID';
+$projectId = getenv('GOOGLE_CLOUD_PROJECT') ?: 'YOUR_PROJECT_ID';
$service = getenv('GAE_SERVICE') ?: 'error_reporting_quickstart';
$version = getenv('GAE_VERSION') ?: 'test';
@@ -30,5 +30,5 @@
Bootstrap::init($psrLogger);
print('Throwing a test exception. You can view the message at https://console.cloud.google.com/errors.' . PHP_EOL);
-throw new Exception('quickstart.php test exception');
+throw new Exception('Something went wrong');
# [END error_reporting_quickstart]
diff --git a/error_reporting/test/quickstartTest.php b/error_reporting/test/quickstartTest.php
index d8697c1b44..603e17accd 100644
--- a/error_reporting/test/quickstartTest.php
+++ b/error_reporting/test/quickstartTest.php
@@ -49,6 +49,6 @@ public function testQuickstart()
// Make sure it worked
$this->assertStringContainsString('Throwing a test exception', $output);
- $this->verifyReportedError(self::$projectId, 'quickstart.php test exception');
+ $this->verifyReportedError(self::$projectId, 'Something went wrong');
}
}
From 32c7c9316948a6bf8f5ceb38c842068224e6f355 Mon Sep 17 00:00:00 2001
From: Mend Renovate
Date: Fri, 29 Sep 2023 17:16:43 +0200
Subject: [PATCH 076/285] fix(deps): update dependency google/cloud-language to
^0.31.0 (#1910)
---
language/composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/language/composer.json b/language/composer.json
index 7b37a23096..af0ac8122c 100644
--- a/language/composer.json
+++ b/language/composer.json
@@ -1,6 +1,6 @@
{
"require": {
- "google/cloud-language": "^0.30.2",
+ "google/cloud-language": "^0.31.0",
"google/cloud-storage": "^1.20.1"
}
}
From 4aabf82e377554661ebb6e5fdbfdd588e892de59 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Sun, 1 Oct 2023 13:02:23 -0700
Subject: [PATCH 077/285] chore(tests): stricter static analysis (#1596)
---
.github/workflows/lint.yml | 24 ++--
analyticsdata/src/get_common_metadata.php | 3 +-
.../src/get_metadata_by_property_id.php | 1 +
.../src/run_report_with_aggregations.php | 2 +-
analyticsdata/src/run_report_with_cohorts.php | 2 +-
.../src/run_report_with_date_ranges.php | 2 +-
.../run_report_with_multiple_dimensions.php | 2 +-
.../src/run_report_with_multiple_metrics.php | 2 +-
.../src/run_report_with_named_date_ranges.php | 2 +-
asset/src/batch_get_assets_history.php | 13 ++-
asset/src/list_assets.php | 13 ++-
asset/src/search_all_resources.php | 14 +--
asset/test/assetSearchTest.php | 30 +++--
asset/test/assetTest.php | 52 ++++++---
bigquery/api/src/bigquery_client.php | 1 +
bigquery/api/src/get_table.php | 3 +
bigquery/api/src/stream_row.php | 2 +-
bigtable/src/filter_composing_chain.php | 2 +-
bigtable/src/filter_composing_condition.php | 4 +-
bigtable/src/filter_composing_interleave.php | 4 +-
bigtable/src/filter_limit_block_all.php | 2 +-
bigtable/src/filter_limit_cells_per_col.php | 2 +-
bigtable/src/filter_limit_cells_per_row.php | 2 +-
.../src/filter_limit_cells_per_row_offset.php | 2 +-
.../src/filter_limit_col_family_regex.php | 2 +-
.../src/filter_limit_col_qualifier_regex.php | 2 +-
bigtable/src/filter_limit_col_range.php | 2 +-
bigtable/src/filter_limit_pass_all.php | 2 +-
bigtable/src/filter_limit_row_regex.php | 2 +-
bigtable/src/filter_limit_row_sample.php | 2 +-
bigtable/src/filter_limit_timestamp_range.php | 2 +-
bigtable/src/filter_limit_value_range.php | 2 +-
bigtable/src/filter_limit_value_regex.php | 2 +-
bigtable/src/filter_modify_apply_label.php | 2 +-
bigtable/src/filter_modify_strip_value.php | 2 +-
bigtable/src/get_instance.php | 2 +-
bigtable/src/insert_update_rows.php | 2 +-
bigtable/src/list_tables.php | 1 +
bigtable/src/read_filter.php | 2 +-
bigtable/src/read_prefix.php | 2 +-
bigtable/src/read_row.php | 2 +-
bigtable/src/read_row_partial.php | 2 +-
bigtable/src/read_row_range.php | 2 +-
bigtable/src/read_row_ranges.php | 2 +-
bigtable/src/read_rows.php | 2 +-
bigtable/src/write_batch.php | 4 +-
bigtable/src/write_simple.php | 2 +-
cloud_sql/mysql/pdo/src/Votes.php | 6 +-
cloud_sql/postgres/pdo/src/Votes.php | 6 +-
cloud_sql/sqlserver/pdo/src/Votes.php | 6 +-
.../src/disable_usage_export_bucket.php | 5 +-
.../start_instance_with_encryption_key.php | 5 +-
datastore/api/src/functions/concepts.php | 46 ++++----
datastore/tutorial/src/delete_task.php | 2 +-
datastore/tutorial/src/mark_done.php | 2 +-
dlp/src/deidentify_dates.php | 8 +-
dlp/src/deidentify_deterministic.php | 2 +-
...nspect_send_data_to_hybrid_job_trigger.php | 3 +-
firestore/src/City.php | 21 +++-
.../src/solution_sharded_counter_create.php | 2 +-
.../solution_sharded_counter_increment.php | 4 +-
iap/src/validate_jwt.php | 25 +++--
kms/src/create_key_asymmetric_decrypt.php | 2 +-
kms/src/create_key_asymmetric_sign.php | 2 +-
kms/src/create_key_hsm.php | 2 +-
kms/src/create_key_labels.php | 2 +-
kms/src/create_key_mac.php | 2 +-
kms/src/create_key_ring.php | 2 +-
kms/src/create_key_rotation_schedule.php | 2 +-
.../create_key_symmetric_encrypt_decrypt.php | 2 +-
kms/src/create_key_version.php | 2 +-
kms/src/disable_key_version.php | 2 +-
kms/src/enable_key_version.php | 2 +-
kms/src/encrypt_asymmetric.php | 2 +-
kms/src/iam_remove_member.php | 2 +-
kms/src/update_key_add_rotation.php | 2 +-
kms/src/update_key_remove_labels.php | 2 +-
kms/src/update_key_remove_rotation.php | 2 +-
kms/src/update_key_update_labels.php | 2 +-
kms/src/verify_asymmetric_ec.php | 2 +-
kms/src/verify_asymmetric_rsa.php | 2 +-
logging/src/update_sink.php | 2 +-
logging/src/write_with_monolog_logger.php | 3 +-
logging/src/write_with_psr_logger.php | 2 +
.../create_job_with_concatenated_inputs.php | 8 +-
media/videostitcher/src/create_cdn_key.php | 4 +-
media/videostitcher/src/update_cdn_key.php | 4 +-
monitoring/src/alert_create_channel.php | 2 +-
monitoring/src/alert_delete_channel.php | 3 +-
monitoring/src/alert_replace_channels.php | 4 +-
monitoring/src/alert_restore_policies.php | 12 +-
monitoring/src/list_uptime_check_ips.php | 2 +-
monitoring/src/list_uptime_checks.php | 2 +-
monitoring/src/read_timeseries_align.php | 2 +-
monitoring/src/read_timeseries_fields.php | 2 +-
monitoring/src/read_timeseries_reduce.php | 2 +-
monitoring/src/read_timeseries_simple.php | 2 +-
monitoring/src/update_uptime_check.php | 14 ++-
pubsub/api/src/create_avro_schema.php | 7 +-
.../api/src/create_bigquery_subscription.php | 2 +-
pubsub/api/src/create_proto_schema.php | 5 +-
.../src/create_subscription_with_filter.php | 8 +-
.../src/dead_letter_update_subscription.php | 8 +-
pubsub/api/src/publish_avro_records.php | 3 +-
pubsub/api/src/pubsub_client.php | 2 +
spanner/src/delete_data_with_dml.php | 2 +-
spanner/src/get_commit_stats.php | 2 +-
spanner/src/insert_data_with_dml.php | 2 +-
.../src/list_instance_config_operations.php | 2 +-
spanner/src/list_instance_configs.php | 6 +-
spanner/src/pg_numeric_data_type.php | 2 +-
spanner/src/set_transaction_tag.php | 2 +-
spanner/src/update_data_with_dml.php | 2 +-
spanner/src/update_data_with_dml_structs.php | 2 +-
.../src/update_data_with_dml_timestamp.php | 2 +-
spanner/src/write_data_with_dml.php | 2 +-
.../src/write_data_with_dml_transaction.php | 2 +-
spanner/src/write_read_with_dml.php | 2 +-
storage/src/upload_object.php | 4 +-
storage/src/upload_object_from_memory.php | 4 +-
storage/src/upload_with_kms_key.php | 4 +-
tasks/src/create_http_task.php | 5 +-
testing/composer.json | 1 +
.../compute/cloud-client/instances.neon.dist | 5 +
testing/phpstan/default.neon.dist | 3 +
testing/phpstan/pubsub/api.neon.dist | 8 ++
testing/run_staticanalysis_check.sh | 106 ++++++++++++++++++
testing/sample_helpers.php | 10 +-
vision/src/detect_face.php | 2 +-
vision/src/detect_label.php | 2 +-
vision/src/detect_label_gcs.php | 2 +-
vision/src/detect_pdf_gcs.php | 2 +-
vision/src/detect_web_with_geo_metadata.php | 2 +-
133 files changed, 463 insertions(+), 246 deletions(-)
create mode 100644 testing/phpstan/compute/cloud-client/instances.neon.dist
create mode 100644 testing/phpstan/default.neon.dist
create mode 100644 testing/phpstan/pubsub/api.neon.dist
create mode 100644 testing/run_staticanalysis_check.sh
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index db80ccde4e..c4ddad101f 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -21,19 +21,23 @@ jobs:
staticanalysis:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
+ with:
+ ref: ${{ github.event.pull_request.head.ref }}
+ fetch-depth: 5
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
-
+ - uses: jwalton/gh-find-current-pr@v1
+ id: findPr
+ with:
+ state: open
- name: Run Script
run: |
- composer global require phpstan/phpstan
- for dir in $(find * -type d -name src -not -path 'appengine/*' -not -path '*/vendor/*' -exec dirname {} \;);
- do
- echo -e "\n RUNNING for => $dir\n"
- composer install --working-dir=$dir --ignore-platform-reqs
- echo " autoload.php
- ~/.composer/vendor/bin/phpstan analyse $dir/src --autoload-file=autoload.php
- done
+ composer install -d testing/
+ git fetch --no-tags --prune --depth=5 origin main
+ bash testing/run_staticanalysis_check.sh
+ env:
+ PULL_REQUEST_NUMBER: ${{ steps.findPr.outputs.pr }}
+
diff --git a/analyticsdata/src/get_common_metadata.php b/analyticsdata/src/get_common_metadata.php
index 5a8d9a1141..3019f8b5c3 100644
--- a/analyticsdata/src/get_common_metadata.php
+++ b/analyticsdata/src/get_common_metadata.php
@@ -36,7 +36,7 @@
/**
* Retrieves dimensions and metrics available for all Google Analytics 4 properties.
*/
-function get_common_metadata()
+function get_common_metadata(): void
{
// Create an instance of the Google Analytics Data API client library.
$client = new BetaAnalyticsDataClient();
@@ -56,6 +56,7 @@ function get_common_metadata()
$response = $client->getMetadata($request);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
+ return;
}
print('Dimensions and metrics available for all Google Analytics 4 properties:');
diff --git a/analyticsdata/src/get_metadata_by_property_id.php b/analyticsdata/src/get_metadata_by_property_id.php
index 3d58c0b26a..178a748761 100644
--- a/analyticsdata/src/get_metadata_by_property_id.php
+++ b/analyticsdata/src/get_metadata_by_property_id.php
@@ -52,6 +52,7 @@ function get_metadata_by_property_id(string $propertyId)
$response = $client->getMetadata($request);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
+ return;
}
printf(
diff --git a/analyticsdata/src/run_report_with_aggregations.php b/analyticsdata/src/run_report_with_aggregations.php
index 206dbc0a1c..a2ef2affcb 100644
--- a/analyticsdata/src/run_report_with_aggregations.php
+++ b/analyticsdata/src/run_report_with_aggregations.php
@@ -38,7 +38,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report which includes total, maximum and minimum values
* for each metric.
*/
diff --git a/analyticsdata/src/run_report_with_cohorts.php b/analyticsdata/src/run_report_with_cohorts.php
index 625183e786..29ec2dc7d5 100644
--- a/analyticsdata/src/run_report_with_cohorts.php
+++ b/analyticsdata/src/run_report_with_cohorts.php
@@ -40,7 +40,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report on a cohort of users whose first session happened on the
* same week. The number of active users and user retention rate is calculated
* for the cohort using WEEKLY granularity.
diff --git a/analyticsdata/src/run_report_with_date_ranges.php b/analyticsdata/src/run_report_with_date_ranges.php
index a75f6eca82..aceb328d57 100644
--- a/analyticsdata/src/run_report_with_date_ranges.php
+++ b/analyticsdata/src/run_report_with_date_ranges.php
@@ -37,7 +37,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report using two date ranges.
*/
function run_report_with_date_ranges(string $propertyId)
diff --git a/analyticsdata/src/run_report_with_multiple_dimensions.php b/analyticsdata/src/run_report_with_multiple_dimensions.php
index c0e540f032..4b7f7ebd32 100644
--- a/analyticsdata/src/run_report_with_multiple_dimensions.php
+++ b/analyticsdata/src/run_report_with_multiple_dimensions.php
@@ -37,7 +37,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report of active users grouped by three dimensions.
*/
function run_report_with_multiple_dimensions(string $propertyId)
diff --git a/analyticsdata/src/run_report_with_multiple_metrics.php b/analyticsdata/src/run_report_with_multiple_metrics.php
index d6c8e2c260..e96c9829c8 100644
--- a/analyticsdata/src/run_report_with_multiple_metrics.php
+++ b/analyticsdata/src/run_report_with_multiple_metrics.php
@@ -37,7 +37,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report of active users grouped by three metrics.
*/
function run_report_with_multiple_metrics(string $propertyId)
diff --git a/analyticsdata/src/run_report_with_named_date_ranges.php b/analyticsdata/src/run_report_with_named_date_ranges.php
index 9d0357fce8..59b71ff7da 100644
--- a/analyticsdata/src/run_report_with_named_date_ranges.php
+++ b/analyticsdata/src/run_report_with_named_date_ranges.php
@@ -37,7 +37,7 @@
use Google\Analytics\Data\V1beta\RunReportResponse;
/**
- * @param string $propertyID Your GA-4 Property ID
+ * @param string $propertyId Your GA-4 Property ID
* Runs a report using named date ranges.
*/
function run_report_with_named_date_ranges(string $propertyId)
diff --git a/asset/src/batch_get_assets_history.php b/asset/src/batch_get_assets_history.php
index 747f0e2b0e..2ea1e2bf59 100644
--- a/asset/src/batch_get_assets_history.php
+++ b/asset/src/batch_get_assets_history.php
@@ -23,14 +23,23 @@
use Google\Cloud\Asset\V1\TimeWindow;
use Google\Protobuf\Timestamp;
-function batch_get_assets_history(string $projectId, array $assetNames)
+/**
+ * @param string $projectId Tthe project Id for list assets.
+ * @param string[] $assetNames (Optional) Asset types to list for.
+ */
+function batch_get_assets_history(string $projectId, array $assetNames): void
{
$client = new AssetServiceClient();
$formattedParent = $client->projectName($projectId);
$contentType = ContentType::RESOURCE;
$readTimeWindow = new TimeWindow(['start_time' => new Timestamp(['seconds' => time()])]);
- $resp = $client->batchGetAssetsHistory($formattedParent, $contentType, $readTimeWindow, ['assetNames' => $assetNames]);
+ $resp = $client->batchGetAssetsHistory(
+ $formattedParent,
+ $contentType,
+ $readTimeWindow,
+ ['assetNames' => $assetNames]
+ );
# Do things with response.
print($resp->serializeToString());
diff --git a/asset/src/list_assets.php b/asset/src/list_assets.php
index 6d587a6fa3..bed0d3cb08 100644
--- a/asset/src/list_assets.php
+++ b/asset/src/list_assets.php
@@ -21,12 +21,15 @@
use Google\Cloud\Asset\V1\AssetServiceClient;
/**
- * @param string $projectId Tthe project Id for list assets.
- * @param string|array $assetTypes (Optional) Asset types to list for.
- * @param int $pageSize (Optional) Size of one result page.
+ * @param string $projectId Tthe project Id for list assets.
+ * @param string[] $assetTypes (Optional) Asset types to list for.
+ * @param int $pageSize (Optional) Size of one result page.
*/
-function list_assets(string $projectId, array $assetTypes = [], int $pageSize = null)
-{
+function list_assets(
+ string $projectId,
+ array $assetTypes = [],
+ int $pageSize = null
+): void {
// Instantiate a client.
$client = new AssetServiceClient();
diff --git a/asset/src/search_all_resources.php b/asset/src/search_all_resources.php
index 3434851d4b..c7fdbda86b 100644
--- a/asset/src/search_all_resources.php
+++ b/asset/src/search_all_resources.php
@@ -21,12 +21,12 @@
use Google\Cloud\Asset\V1\AssetServiceClient;
/**
- * @param string $scope Scope of the search
- * @param string $query (Optional) Query statement
- * @param string|array $assetTypes (Optional) Asset types to search for
- * @param int $pageSize (Optional) Size of each result page
- * @param string $pageToken (Optional) Token produced by the preceding call
- * @param string $orderBy (Optional) Fields to sort the results
+ * @param string $scope Scope of the search
+ * @param string $query (Optional) Query statement
+ * @param string[] $assetTypes (Optional) Asset types to search for
+ * @param int $pageSize (Optional) Size of each result page
+ * @param string $pageToken (Optional) Token produced by the preceding call
+ * @param string $orderBy (Optional) Fields to sort the results
*/
function search_all_resources(
string $scope,
@@ -35,7 +35,7 @@ function search_all_resources(
int $pageSize = 0,
string $pageToken = '',
string $orderBy = ''
-) {
+): void {
// Instantiate a client.
$asset = new AssetServiceClient();
diff --git a/asset/test/assetSearchTest.php b/asset/test/assetSearchTest.php
index c5db6e0ad0..7d05c01cce 100644
--- a/asset/test/assetSearchTest.php
+++ b/asset/test/assetSearchTest.php
@@ -18,6 +18,7 @@
namespace Google\Cloud\Samples\Asset;
use Google\Cloud\BigQuery\BigQueryClient;
+use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
use PHPUnitRetry\RetryTrait;
@@ -30,6 +31,7 @@
*/
class assetSearchTest extends TestCase
{
+ use EventuallyConsistentTestTrait;
use RetryTrait;
use TestTrait;
@@ -55,12 +57,16 @@ public function testSearchAllResources()
$scope = 'projects/' . self::$projectId;
$query = 'name:' . self::$datasetId;
- $output = $this->runFunctionSnippet('search_all_resources', [
- $scope,
- $query
- ]);
+ $this->runEventuallyConsistentTest(
+ function () use ($scope, $query) {
+ $output = $this->runFunctionSnippet('search_all_resources', [
+ $scope,
+ $query
+ ]);
- $this->assertStringContainsString(self::$datasetId, $output);
+ $this->assertStringContainsString(self::$datasetId, $output);
+ }
+ );
}
public function testSearchAllIamPolicies()
@@ -68,10 +74,14 @@ public function testSearchAllIamPolicies()
$scope = 'projects/' . self::$projectId;
$query = 'policy:roles/owner';
- $output = $this->runFunctionSnippet('search_all_iam_policies', [
- $scope,
- $query
- ]);
- $this->assertStringContainsString(self::$projectId, $output);
+ $this->runEventuallyConsistentTest(
+ function () use ($scope, $query) {
+ $output = $this->runFunctionSnippet('search_all_iam_policies', [
+ $scope,
+ $query
+ ]);
+ $this->assertStringContainsString(self::$projectId, $output);
+ }
+ );
}
}
diff --git a/asset/test/assetTest.php b/asset/test/assetTest.php
index ae2b83a45d..3d3d6b1717 100644
--- a/asset/test/assetTest.php
+++ b/asset/test/assetTest.php
@@ -18,6 +18,7 @@
namespace Google\Cloud\Samples\Asset;
use Google\Cloud\Storage\StorageClient;
+use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
use Google\Cloud\TestUtils\TestTrait;
use PHPUnit\Framework\TestCase;
use PHPUnitRetry\RetryTrait;
@@ -30,6 +31,7 @@
*/
class assetTest extends TestCase
{
+ use EventuallyConsistentTestTrait;
use RetryTrait;
use TestTrait;
@@ -53,36 +55,50 @@ public function testExportAssets()
{
$fileName = 'my-assets.txt';
$dumpFilePath = 'gs://' . self::$bucketName . '/' . $fileName;
- $output = $this->runFunctionSnippet('export_assets', [
- 'projectId' => self::$projectId,
- 'dumpFilePath' => $dumpFilePath,
- ]);
- $assetFile = self::$bucket->object($fileName);
- $this->assertEquals($assetFile->name(), $fileName);
- $assetFile->delete();
+
+ $this->runEventuallyConsistentTest(
+ function () use ($fileName, $dumpFilePath) {
+ $output = $this->runFunctionSnippet('export_assets', [
+ 'projectId' => self::$projectId,
+ 'dumpFilePath' => $dumpFilePath,
+ ]);
+ $assetFile = self::$bucket->object($fileName);
+ $this->assertEquals($assetFile->name(), $fileName);
+ $assetFile->delete();
+ }
+ );
}
public function testListAssets()
{
$assetName = '//storage.googleapis.com/' . self::$bucketName;
- $output = $this->runFunctionSnippet('list_assets', [
- 'projectId' => self::$projectId,
- 'assetTypes' => ['storage.googleapis.com/Bucket'],
- 'pageSize' => 1000,
- ]);
- $this->assertStringContainsString($assetName, $output);
+ $this->runEventuallyConsistentTest(
+ function () use ($assetName) {
+ $output = $this->runFunctionSnippet('list_assets', [
+ 'projectId' => self::$projectId,
+ 'assetTypes' => ['storage.googleapis.com/Bucket'],
+ 'pageSize' => 1000,
+ ]);
+
+ $this->assertStringContainsString($assetName, $output);
+ }
+ );
}
public function testBatchGetAssetsHistory()
{
$assetName = '//storage.googleapis.com/' . self::$bucketName;
- $output = $this->runFunctionSnippet('batch_get_assets_history', [
- 'projectId' => self::$projectId,
- 'assetNames' => [$assetName],
- ]);
+ $this->runEventuallyConsistentTest(
+ function () use ($assetName) {
+ $output = $this->runFunctionSnippet('batch_get_assets_history', [
+ 'projectId' => self::$projectId,
+ 'assetNames' => [$assetName],
+ ]);
- $this->assertStringContainsString($assetName, $output);
+ $this->assertStringContainsString($assetName, $output);
+ }
+ );
}
}
diff --git a/bigquery/api/src/bigquery_client.php b/bigquery/api/src/bigquery_client.php
index e616a1aa49..340567ef3a 100644
--- a/bigquery/api/src/bigquery_client.php
+++ b/bigquery/api/src/bigquery_client.php
@@ -24,6 +24,7 @@
if (isset($argv)) {
return print("This file is for example only and cannot be executed\n");
}
+$projectId = '';
/**
* This file is to be used as an example only!
diff --git a/bigquery/api/src/get_table.php b/bigquery/api/src/get_table.php
index e836d2647c..96a40757cf 100644
--- a/bigquery/api/src/get_table.php
+++ b/bigquery/api/src/get_table.php
@@ -24,6 +24,9 @@
if (isset($argv)) {
return print("This file is for example only and cannot be executed\n");
}
+$projectId = '';
+$datasetId = '';
+$tableId = '';
# [START bigquery_get_table]
use Google\Cloud\BigQuery\BigQueryClient;
diff --git a/bigquery/api/src/stream_row.php b/bigquery/api/src/stream_row.php
index fa320c9135..943da714ff 100644
--- a/bigquery/api/src/stream_row.php
+++ b/bigquery/api/src/stream_row.php
@@ -32,7 +32,7 @@
* @param string $projectId The project Id of your Google Cloud Project.
* @param string $datasetId The BigQuery dataset ID.
* @param string $tableId The BigQuery table ID.
- * @param array $data Json encoded data For eg,
+ * @param string $data Json encoded data For eg,
* $data = json_encode([
* "field1" => "value1",
* "field2" => "value2",
diff --git a/bigtable/src/filter_composing_chain.php b/bigtable/src/filter_composing_chain.php
index e0c37ad859..55f921bc3a 100644
--- a/bigtable/src/filter_composing_chain.php
+++ b/bigtable/src/filter_composing_chain.php
@@ -61,7 +61,7 @@ function filter_composing_chain(
// [END bigtable_filters_composing_chain]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_composing_condition.php b/bigtable/src/filter_composing_condition.php
index a16dd68772..8ab84ce407 100644
--- a/bigtable/src/filter_composing_condition.php
+++ b/bigtable/src/filter_composing_condition.php
@@ -47,7 +47,7 @@ function filter_composing_condition(
$filter = Filter::condition(
Filter::chain()
- ->addFilter(Filter::value()->exactMatch(unpack('C*', 1)))
+ ->addFilter(Filter::value()->exactMatch('1'))
->addFilter(Filter::qualifier()->exactMatch('data_plan_10gb'))
)
->then(Filter::label('passed-filter'))
@@ -65,7 +65,7 @@ function filter_composing_condition(
// [END bigtable_filters_composing_condition]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_composing_interleave.php b/bigtable/src/filter_composing_interleave.php
index 8bbcb807e0..6b86ce822c 100644
--- a/bigtable/src/filter_composing_interleave.php
+++ b/bigtable/src/filter_composing_interleave.php
@@ -46,7 +46,7 @@ function filter_composing_interleave(
$table = $dataClient->table($instanceId, $tableId);
$filter = Filter::interleave()
- ->addFilter(Filter::value()->exactMatch(unpack('C*', 1)))
+ ->addFilter(Filter::value()->exactMatch('1'))
->addFilter(Filter::qualifier()->exactMatch('os_build'));
$rows = $table->readRows([
@@ -61,7 +61,7 @@ function filter_composing_interleave(
// [END bigtable_filters_composing_interleave]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_block_all.php b/bigtable/src/filter_limit_block_all.php
index d6048a8368..543347b489 100644
--- a/bigtable/src/filter_limit_block_all.php
+++ b/bigtable/src/filter_limit_block_all.php
@@ -59,7 +59,7 @@ function filter_limit_block_all(
// [END bigtable_filters_limit_block_all]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_cells_per_col.php b/bigtable/src/filter_limit_cells_per_col.php
index 6319fcace9..47b2fb2ffa 100644
--- a/bigtable/src/filter_limit_cells_per_col.php
+++ b/bigtable/src/filter_limit_cells_per_col.php
@@ -59,7 +59,7 @@ function filter_limit_cells_per_col(
// [END bigtable_filters_limit_cells_per_col]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_cells_per_row.php b/bigtable/src/filter_limit_cells_per_row.php
index 460818204d..f33bab55f1 100644
--- a/bigtable/src/filter_limit_cells_per_row.php
+++ b/bigtable/src/filter_limit_cells_per_row.php
@@ -59,7 +59,7 @@ function filter_limit_cells_per_row(
// [END bigtable_filters_limit_cells_per_row]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_cells_per_row_offset.php b/bigtable/src/filter_limit_cells_per_row_offset.php
index 062bcdda5c..6a2bb451b0 100644
--- a/bigtable/src/filter_limit_cells_per_row_offset.php
+++ b/bigtable/src/filter_limit_cells_per_row_offset.php
@@ -59,7 +59,7 @@ function filter_limit_cells_per_row_offset(
// [END bigtable_filters_limit_cells_per_row_offset]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_col_family_regex.php b/bigtable/src/filter_limit_col_family_regex.php
index dcab0ca27c..fff1c13a15 100644
--- a/bigtable/src/filter_limit_col_family_regex.php
+++ b/bigtable/src/filter_limit_col_family_regex.php
@@ -59,7 +59,7 @@ function filter_limit_col_family_regex(
// [END bigtable_filters_limit_col_family_regex]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_col_qualifier_regex.php b/bigtable/src/filter_limit_col_qualifier_regex.php
index f624c059b6..dc8cef4693 100644
--- a/bigtable/src/filter_limit_col_qualifier_regex.php
+++ b/bigtable/src/filter_limit_col_qualifier_regex.php
@@ -59,7 +59,7 @@ function filter_limit_col_qualifier_regex(
// [END bigtable_filters_limit_col_qualifier_regex]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_col_range.php b/bigtable/src/filter_limit_col_range.php
index f7f8cc612d..f9604bcd53 100644
--- a/bigtable/src/filter_limit_col_range.php
+++ b/bigtable/src/filter_limit_col_range.php
@@ -62,7 +62,7 @@ function filter_limit_col_range(
// [END bigtable_filters_limit_col_range]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_pass_all.php b/bigtable/src/filter_limit_pass_all.php
index fa93437835..06314eebcf 100644
--- a/bigtable/src/filter_limit_pass_all.php
+++ b/bigtable/src/filter_limit_pass_all.php
@@ -59,7 +59,7 @@ function filter_limit_pass_all(
// [END bigtable_filters_limit_pass_all]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_row_regex.php b/bigtable/src/filter_limit_row_regex.php
index 4df7f2ea5f..4a69f1d784 100644
--- a/bigtable/src/filter_limit_row_regex.php
+++ b/bigtable/src/filter_limit_row_regex.php
@@ -59,7 +59,7 @@ function filter_limit_row_regex(
// [END bigtable_filters_limit_row_regex]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_row_sample.php b/bigtable/src/filter_limit_row_sample.php
index b0d25570ea..ae10f34a88 100644
--- a/bigtable/src/filter_limit_row_sample.php
+++ b/bigtable/src/filter_limit_row_sample.php
@@ -59,7 +59,7 @@ function filter_limit_row_sample(
// [END bigtable_filters_limit_row_sample]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_timestamp_range.php b/bigtable/src/filter_limit_timestamp_range.php
index 0d0cf8f4c7..b652886cae 100644
--- a/bigtable/src/filter_limit_timestamp_range.php
+++ b/bigtable/src/filter_limit_timestamp_range.php
@@ -66,7 +66,7 @@ function filter_limit_timestamp_range(
// [END bigtable_filters_limit_timestamp_range]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_value_range.php b/bigtable/src/filter_limit_value_range.php
index abcbfb3be5..e9176f0ea8 100644
--- a/bigtable/src/filter_limit_value_range.php
+++ b/bigtable/src/filter_limit_value_range.php
@@ -62,7 +62,7 @@ function filter_limit_value_range(
// [END bigtable_filters_limit_value_range]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_limit_value_regex.php b/bigtable/src/filter_limit_value_regex.php
index 6ba48cf7d4..0b0602a5ba 100644
--- a/bigtable/src/filter_limit_value_regex.php
+++ b/bigtable/src/filter_limit_value_regex.php
@@ -59,7 +59,7 @@ function filter_limit_value_regex(
// [END bigtable_filters_limit_value_regex]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_modify_apply_label.php b/bigtable/src/filter_modify_apply_label.php
index 02c4f46be8..a8b16f8c1d 100644
--- a/bigtable/src/filter_modify_apply_label.php
+++ b/bigtable/src/filter_modify_apply_label.php
@@ -59,7 +59,7 @@ function filter_modify_apply_label(
// [END bigtable_filters_modify_apply_label]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/filter_modify_strip_value.php b/bigtable/src/filter_modify_strip_value.php
index 5fb521b3ec..d1fa692db7 100644
--- a/bigtable/src/filter_modify_strip_value.php
+++ b/bigtable/src/filter_modify_strip_value.php
@@ -59,7 +59,7 @@ function filter_modify_strip_value(
// [END bigtable_filters_modify_strip_value]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/get_instance.php b/bigtable/src/get_instance.php
index 7d5daa9b4a..d0674d11de 100644
--- a/bigtable/src/get_instance.php
+++ b/bigtable/src/get_instance.php
@@ -67,7 +67,7 @@ function get_instance(
// Labels are an object of the MapField class which implement the IteratorAggregate, Countable
// and ArrayAccess interfaces so you can do the following:
printf("\tNum of Labels: " . $labels->count() . PHP_EOL);
- printf("\tLabel with a key(dev-label): " . ($labels->offsetExists('dev-label') ? $labels['dev-label'] : 'N/A') . PHP_EOL);
+ printf("\tLabel with a key(dev-label): " . ($labels['dev-label'] ?? 'N/A') . PHP_EOL);
// we can even loop over all the labels
foreach ($labels as $key => $val) {
diff --git a/bigtable/src/insert_update_rows.php b/bigtable/src/insert_update_rows.php
index f1d82de874..63acfa90bc 100644
--- a/bigtable/src/insert_update_rows.php
+++ b/bigtable/src/insert_update_rows.php
@@ -102,7 +102,7 @@ function insert_update_rows(
printf('Data inserted successfully!' . PHP_EOL);
}
-function time_in_microseconds()
+function time_in_microseconds(): float
{
$mt = microtime(true);
$mt = sprintf('%.03f', $mt);
diff --git a/bigtable/src/list_tables.php b/bigtable/src/list_tables.php
index 03a8c84369..a79dcbc4d4 100644
--- a/bigtable/src/list_tables.php
+++ b/bigtable/src/list_tables.php
@@ -44,6 +44,7 @@ function list_tables(
printf('Listing Tables:' . PHP_EOL);
$tables = $tableAdminClient->listTables($instanceName)->iterateAllElements();
+ $tables = iterator_to_array($tables);
if (empty($tables)) {
print('No table exists.' . PHP_EOL);
return;
diff --git a/bigtable/src/read_filter.php b/bigtable/src/read_filter.php
index 1e3e59fe1f..1f9c56814a 100644
--- a/bigtable/src/read_filter.php
+++ b/bigtable/src/read_filter.php
@@ -58,7 +58,7 @@ function read_filter(
// [END bigtable_reads_filter]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_prefix.php b/bigtable/src/read_prefix.php
index 5434c66d91..bec5f7f8b0 100644
--- a/bigtable/src/read_prefix.php
+++ b/bigtable/src/read_prefix.php
@@ -67,7 +67,7 @@ function read_prefix(
// [END bigtable_reads_prefix]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_row.php b/bigtable/src/read_row.php
index 82f4760d3d..2c32a70b8c 100644
--- a/bigtable/src/read_row.php
+++ b/bigtable/src/read_row.php
@@ -53,7 +53,7 @@ function read_row(
// [START bigtable_reads_print]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_row_partial.php b/bigtable/src/read_row_partial.php
index a60406ab08..3fef92a813 100644
--- a/bigtable/src/read_row_partial.php
+++ b/bigtable/src/read_row_partial.php
@@ -54,7 +54,7 @@ function read_row_partial(
// [END bigtable_reads_row_partial]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_row_range.php b/bigtable/src/read_row_range.php
index da3f42cef7..b6d45f5892 100644
--- a/bigtable/src/read_row_range.php
+++ b/bigtable/src/read_row_range.php
@@ -60,7 +60,7 @@ function read_row_range(
// [END bigtable_reads_row_range]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_row_ranges.php b/bigtable/src/read_row_ranges.php
index c82b82e24b..7fa67ef197 100644
--- a/bigtable/src/read_row_ranges.php
+++ b/bigtable/src/read_row_ranges.php
@@ -64,7 +64,7 @@ function read_row_ranges(
// [END bigtable_reads_row_ranges]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/read_rows.php b/bigtable/src/read_rows.php
index 12009624fa..c17b26fea6 100644
--- a/bigtable/src/read_rows.php
+++ b/bigtable/src/read_rows.php
@@ -55,7 +55,7 @@ function read_rows(
// [END bigtable_reads_rows]
// Helper function for printing the row data
-function print_row($key, $row)
+function print_row(string $key, array $row): void
{
printf('Reading data for row %s' . PHP_EOL, $key);
foreach ((array) $row as $family => $cols) {
diff --git a/bigtable/src/write_batch.php b/bigtable/src/write_batch.php
index 9da801723b..1d9f0a8933 100644
--- a/bigtable/src/write_batch.php
+++ b/bigtable/src/write_batch.php
@@ -49,10 +49,10 @@ function write_batch(
$columnFamilyId = 'stats_summary';
$mutations = [
(new Mutations())
- ->upsert($columnFamilyId, 'connected_wifi', 1, $timestampMicros)
+ ->upsert($columnFamilyId, 'connected_wifi', '1', $timestampMicros)
->upsert($columnFamilyId, 'os_build', '12155.0.0-rc1', $timestampMicros),
(new Mutations())
- ->upsert($columnFamilyId, 'connected_wifi', 1, $timestampMicros)
+ ->upsert($columnFamilyId, 'connected_wifi', '1', $timestampMicros)
->upsert($columnFamilyId, 'os_build', '12145.0.0-rc6', $timestampMicros)];
$table->mutateRows([
diff --git a/bigtable/src/write_simple.php b/bigtable/src/write_simple.php
index 1e9b20c1dd..336ecf196b 100644
--- a/bigtable/src/write_simple.php
+++ b/bigtable/src/write_simple.php
@@ -49,7 +49,7 @@ function write_simple(
$timestampMicros = time() * 1000 * 1000;
$columnFamilyId = 'stats_summary';
$mutations = (new Mutations())
- ->upsert($columnFamilyId, 'connected_cell', 1, $timestampMicros)
+ ->upsert($columnFamilyId, 'connected_cell', '1', $timestampMicros)
->upsert($columnFamilyId, 'connected_wifi', DataUtil::intToByteString(1), $timestampMicros)
->upsert($columnFamilyId, 'os_build', 'PQ2A.190405.003', $timestampMicros);
diff --git a/cloud_sql/mysql/pdo/src/Votes.php b/cloud_sql/mysql/pdo/src/Votes.php
index 8ca7a38bba..5148bf513d 100644
--- a/cloud_sql/mysql/pdo/src/Votes.php
+++ b/cloud_sql/mysql/pdo/src/Votes.php
@@ -66,7 +66,7 @@ public function createTableIfNotExists()
/**
* Returns a list of the last five votes
*
- * @return array
+ * @return array
*/
public function listVotes(): array
{
@@ -80,7 +80,7 @@ public function listVotes(): array
* Get the number of votes cast for a given value.
*
* @param string $value
- * @param int
+ * @return int
*/
public function getCountByValue(string $value): int
{
@@ -96,7 +96,7 @@ public function getCountByValue(string $value): int
* Insert a new vote into the database
*
* @param string $value The value to vote for.
- * @return boolean
+ * @return bool
*/
public function insertVote(string $value): bool
{
diff --git a/cloud_sql/postgres/pdo/src/Votes.php b/cloud_sql/postgres/pdo/src/Votes.php
index 83e6eeb5aa..89d6aec3b3 100644
--- a/cloud_sql/postgres/pdo/src/Votes.php
+++ b/cloud_sql/postgres/pdo/src/Votes.php
@@ -66,7 +66,7 @@ public function createTableIfNotExists()
/**
* Returns a list of the last five votes
*
- * @return array
+ * @return array
*/
public function listVotes(): array
{
@@ -80,7 +80,7 @@ public function listVotes(): array
* Get the number of votes cast for a given value.
*
* @param string $value
- * @param int
+ * @return int
*/
public function getCountByValue(string $value): int
{
@@ -96,7 +96,7 @@ public function getCountByValue(string $value): int
* Insert a new vote into the database
*
* @param string $value The value to vote for.
- * @return boolean
+ * @return bool
*/
public function insertVote(string $value): bool
{
diff --git a/cloud_sql/sqlserver/pdo/src/Votes.php b/cloud_sql/sqlserver/pdo/src/Votes.php
index 69d429af16..07b543374a 100644
--- a/cloud_sql/sqlserver/pdo/src/Votes.php
+++ b/cloud_sql/sqlserver/pdo/src/Votes.php
@@ -72,7 +72,7 @@ public function createTableIfNotExists()
/**
* Returns a list of the last five votes
*
- * @return array
+ * @return array
*/
public function listVotes(): array
{
@@ -86,7 +86,7 @@ public function listVotes(): array
* Get the number of votes cast for a given value.
*
* @param string $value
- * @param int
+ * @return int
*/
public function getCountByValue(string $value): int
{
@@ -102,7 +102,7 @@ public function getCountByValue(string $value): int
* Insert a new vote into the database
*
* @param string $value The value to vote for.
- * @return boolean
+ * @return bool
*/
public function insertVote(string $value): bool
{
diff --git a/compute/instances/src/disable_usage_export_bucket.php b/compute/instances/src/disable_usage_export_bucket.php
index f5ba386aca..8ce5aa74c4 100644
--- a/compute/instances/src/disable_usage_export_bucket.php
+++ b/compute/instances/src/disable_usage_export_bucket.php
@@ -26,6 +26,7 @@
# [START compute_usage_report_disable]
use Google\Cloud\Compute\V1\ProjectsClient;
use Google\Cloud\Compute\V1\Operation;
+use Google\Cloud\Compute\V1\UsageExportLocation;
/**
* Disable Compute Engine usage export bucket for the Cloud Project.
@@ -36,9 +37,9 @@
*/
function disable_usage_export_bucket(string $projectId)
{
- // Disable the usage export location by sending null as usageExportLocationResource.
+ // Disable the usage export location by sending empty UsageExportLocation as usageExportLocationResource.
$projectsClient = new ProjectsClient();
- $operation = $projectsClient->setUsageExportBucket($projectId, null);
+ $operation = $projectsClient->setUsageExportBucket($projectId, new UsageExportLocation());
// Wait for the operation to complete.
$operation->pollUntilComplete();
diff --git a/compute/instances/src/start_instance_with_encryption_key.php b/compute/instances/src/start_instance_with_encryption_key.php
index 95a7e4ae03..4bfee422b4 100644
--- a/compute/instances/src/start_instance_with_encryption_key.php
+++ b/compute/instances/src/start_instance_with_encryption_key.php
@@ -59,9 +59,12 @@ function start_instance_with_encryption_key(
$customerEncryptionKey = (new CustomerEncryptionKey())
->setRawKey($key);
+ /** @var \Google\Cloud\Compute\V1\AttachedDisk */
+ $disk = $instanceData->getDisks()[0];
+
// Prepare the information about disk encryption.
$diskData = (new CustomerEncryptionKeyProtectedDisk())
- ->setSource($instanceData->getDisks()[0]->getSource())
+ ->setSource($disk->getSource())
->setDiskEncryptionKey($customerEncryptionKey);
// Set request with one disk.
diff --git a/datastore/api/src/functions/concepts.php b/datastore/api/src/functions/concepts.php
index 0c0f4faf22..a5ba3cf9b3 100644
--- a/datastore/api/src/functions/concepts.php
+++ b/datastore/api/src/functions/concepts.php
@@ -19,7 +19,7 @@
use DateTime;
use Google\Cloud\Datastore\DatastoreClient;
-use Google\Cloud\Datastore\Entity;
+use Google\Cloud\Datastore\EntityInterface;
use Google\Cloud\Datastore\EntityIterator;
use Google\Cloud\Datastore\Key;
use Google\Cloud\Datastore\Query\GqlQuery;
@@ -40,7 +40,7 @@ function initialize_client()
* Create a Datastore entity.
*
* @param DatastoreClient $datastore
- * @return Entity
+ * @return EntityInterface
*/
function basic_entity(DatastoreClient $datastore)
{
@@ -59,7 +59,7 @@ function basic_entity(DatastoreClient $datastore)
* Create a Datastore entity and upsert it.
*
* @param DatastoreClient $datastore
- * @return Entity
+ * @return EntityInterface
*/
function upsert(DatastoreClient $datastore)
{
@@ -82,7 +82,7 @@ function upsert(DatastoreClient $datastore)
* an entity with the same key.
*
* @param DatastoreClient $datastore
- * @return Entity
+ * @return EntityInterface
*/
function insert(DatastoreClient $datastore)
{
@@ -102,7 +102,7 @@ function insert(DatastoreClient $datastore)
* Look up a Datastore entity with the given key.
*
* @param DatastoreClient $datastore
- * @return Entity|null
+ * @return EntityInterface|null
*/
function lookup(DatastoreClient $datastore)
{
@@ -117,7 +117,7 @@ function lookup(DatastoreClient $datastore)
* Update a Datastore entity in a transaction.
*
* @param DatastoreClient $datastore
- * @return Entity|null
+ * @return EntityInterface
*/
function update(DatastoreClient $datastore)
{
@@ -149,7 +149,7 @@ function delete(DatastoreClient $datastore, Key $taskKey)
* Upsert multiple Datastore entities.
*
* @param DatastoreClient $datastore
- * @param array $tasks
+ * @param array $tasks
*/
function batch_upsert(DatastoreClient $datastore, array $tasks)
{
@@ -162,8 +162,8 @@ function batch_upsert(DatastoreClient $datastore, array $tasks)
* Lookup multiple entities.
*
* @param DatastoreClient $datastore
- * @param array $keys
- * @return array
+ * @param array $keys
+ * @return array
*/
function batch_lookup(DatastoreClient $datastore, array $keys)
{
@@ -182,7 +182,7 @@ function batch_lookup(DatastoreClient $datastore, array $keys)
* Delete multiple Datastore entities with the given keys.
*
* @param DatastoreClient $datastore
- * @param array $keys
+ * @param array $keys
*/
function batch_delete(DatastoreClient $datastore, array $keys)
{
@@ -255,7 +255,7 @@ function key_with_multilevel_parent(DatastoreClient $datastore)
*
* @param DatastoreClient $datastore
* @param Key $key
- * @return Entity
+ * @return EntityInterface
*/
function properties(DatastoreClient $datastore, Key $key)
{
@@ -281,7 +281,7 @@ function properties(DatastoreClient $datastore, Key $key)
*
* @param DatastoreClient $datastore
* @param Key $key
- * @return Entity
+ * @return EntityInterface
*/
function array_value(DatastoreClient $datastore, Key $key)
{
@@ -347,7 +347,7 @@ function basic_gql_query(DatastoreClient $datastore)
*
* @param DatastoreClient $datastore
* @param Query|GqlQuery $query
- * @return EntityIterator
+ * @return EntityIterator
*/
function run_query(DatastoreClient $datastore, $query)
{
@@ -617,11 +617,11 @@ function limit(DatastoreClient $datastore)
* Fetch a query cursor.
*
* @param DatastoreClient $datastore
- * @param string $pageSize
+ * @param int $pageSize
* @param string $pageCursor
* @return array
*/
-function cursor_paging(DatastoreClient $datastore, $pageSize, $pageCursor = '')
+function cursor_paging(DatastoreClient $datastore, int $pageSize, string $pageCursor = '')
{
$query = $datastore->query()
->kind('Task')
@@ -769,7 +769,7 @@ function unindexed_property_query(DatastoreClient $datastore)
* Create an entity with two array properties.
*
* @param DatastoreClient $datastore
- * @return Entity
+ * @return EntityInterface
*/
function exploding_properties(DatastoreClient $datastore)
{
@@ -848,9 +848,9 @@ function transactional_retry(
* Insert an entity only if there is no entity with the same key.
*
* @param DatastoreClient $datastore
- * @param Entity $task
+ * @param EntityInterface $task
*/
-function get_or_create(DatastoreClient $datastore, Entity $task)
+function get_or_create(DatastoreClient $datastore, EntityInterface $task)
{
// [START datastore_transactional_get_or_create]
$transaction = $datastore->transaction();
@@ -866,7 +866,7 @@ function get_or_create(DatastoreClient $datastore, Entity $task)
* Run a query with an ancestor inside a transaction.
*
* @param DatastoreClient $datastore
- * @return array
+ * @return array
*/
function get_task_list_entities(DatastoreClient $datastore)
{
@@ -890,7 +890,7 @@ function get_task_list_entities(DatastoreClient $datastore)
* Create and run a query with readConsistency option.
*
* @param DatastoreClient $datastore
- * @return EntityIterator
+ * @return EntityIterator
*/
function eventual_consistent_query(DatastoreClient $datastore)
{
@@ -907,7 +907,7 @@ function eventual_consistent_query(DatastoreClient $datastore)
* Create an entity with a parent key.
*
* @param DatastoreClient $datastore
- * @return Entity
+ * @return EntityInterface
*/
function entity_with_parent(DatastoreClient $datastore)
{
@@ -1004,7 +1004,7 @@ function property_run_query(DatastoreClient $datastore)
* Create and run a property query with a kind.
*
* @param DatastoreClient $datastore
- * @return array string>
+ * @return array
*/
function property_by_kind_run_query(DatastoreClient $datastore)
{
@@ -1014,7 +1014,7 @@ function property_by_kind_run_query(DatastoreClient $datastore)
->kind('__property__')
->hasAncestor($ancestorKey);
$result = $datastore->runQuery($query);
- /* @var array string> $properties */
+ /* @var array $properties */
$properties = [];
/* @var Entity $entity */
foreach ($result as $entity) {
diff --git a/datastore/tutorial/src/delete_task.php b/datastore/tutorial/src/delete_task.php
index c7988e64b8..d7ae4e386f 100644
--- a/datastore/tutorial/src/delete_task.php
+++ b/datastore/tutorial/src/delete_task.php
@@ -24,7 +24,7 @@
* Delete a task with a given id.
*
* @param string $projectId The Google Cloud project ID.
- * @param $taskId
+ * @param string $taskId
*/
function delete_task(string $projectId, string $taskId)
{
diff --git a/datastore/tutorial/src/mark_done.php b/datastore/tutorial/src/mark_done.php
index 4094a056e5..4ebf5bcf03 100644
--- a/datastore/tutorial/src/mark_done.php
+++ b/datastore/tutorial/src/mark_done.php
@@ -24,7 +24,7 @@
* Mark a task with a given id as done.
*
* @param string $projectId The Google Cloud project ID.
- * @param int $taskId
+ * @param string $taskId
*/
function mark_done(string $projectId, string $taskId)
{
diff --git a/dlp/src/deidentify_dates.php b/dlp/src/deidentify_dates.php
index b7c05c2342..5309dfe7a4 100644
--- a/dlp/src/deidentify_dates.php
+++ b/dlp/src/deidentify_dates.php
@@ -51,8 +51,8 @@
* @param string $inputCsvFile The path to the CSV file to deidentify
* @param string $outputCsvFile The path to save the date-shifted CSV file to
* @param string $dateFieldNames The comma-separated list of (date) fields in the CSV file to date shift
- * @param string $lowerBoundDays The maximum number of days to shift a date backward
- * @param string $upperBoundDays The maximum number of days to shift a date forward
+ * @param int $lowerBoundDays The maximum number of days to shift a date backward
+ * @param int $upperBoundDays The maximum number of days to shift a date forward
* @param string $contextFieldName (Optional) The column to determine date shift amount based on
* @param string $keyName (Optional) The encrypted ('wrapped') AES-256 key to use when shifting dates
* @param string $wrappedKey (Optional) The name of the Cloud KMS key used to encrypt (wrap) the AES-256 key
@@ -62,8 +62,8 @@ function deidentify_dates(
string $inputCsvFile,
string $outputCsvFile,
string $dateFieldNames,
- string $lowerBoundDays,
- string $upperBoundDays,
+ int $lowerBoundDays,
+ int $upperBoundDays,
string $contextFieldName = '',
string $keyName = '',
string $wrappedKey = ''
diff --git a/dlp/src/deidentify_deterministic.php b/dlp/src/deidentify_deterministic.php
index 29bf72f33b..ee951eace3 100644
--- a/dlp/src/deidentify_deterministic.php
+++ b/dlp/src/deidentify_deterministic.php
@@ -48,7 +48,7 @@
* @param string $kmsKeyName The name of the Cloud KMS key used to encrypt ('wrap') the AES-256 key.
* Example: key_name = 'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME'.
* @param string $infoTypeName The Info type name to be inspect.
- * @param string $surrogateType The name of the surrogate custom info type to use.
+ * @param string $surrogateTypeName The name of the surrogate custom info type to use.
* Only necessary if you want to reverse the deidentification process. Can be essentially any arbitrary
* string, as long as it doesn't appear in your dataset otherwise.
* @param string $wrappedAesKey The encrypted ('wrapped') AES-256 key to use.
diff --git a/dlp/src/inspect_send_data_to_hybrid_job_trigger.php b/dlp/src/inspect_send_data_to_hybrid_job_trigger.php
index 6cec8978de..49088d30ca 100644
--- a/dlp/src/inspect_send_data_to_hybrid_job_trigger.php
+++ b/dlp/src/inspect_send_data_to_hybrid_job_trigger.php
@@ -25,6 +25,7 @@
# [START dlp_inspect_send_data_to_hybrid_job_trigger]
+use Google\ApiCore\ApiException;
use Google\Cloud\Dlp\V2\Container;
use Google\Cloud\Dlp\V2\DlpServiceClient;
use Google\Cloud\Dlp\V2\ContentItem;
@@ -76,7 +77,7 @@ function inspect_send_data_to_hybrid_job_trigger(
$triggerJob = null;
try {
$triggerJob = $dlp->activateJobTrigger($name);
- } catch (\InvalidArgumentException $e) {
+ } catch (ApiException $e) {
$result = $dlp->listDlpJobs($parent, ['filter' => 'trigger_name=' . $name]);
foreach ($result as $job) {
$triggerJob = $job;
diff --git a/firestore/src/City.php b/firestore/src/City.php
index 48598a0af9..4c940c001c 100644
--- a/firestore/src/City.php
+++ b/firestore/src/City.php
@@ -26,19 +26,22 @@
# [START firestore_data_custom_type_definition]
class City
{
- /* var string */
+ /** @var string */
public $name;
- /* var string */
+ /** @var string */
public $state;
- /* var string */
+ /** @var string */
public $country;
- /* var bool */
+ /** @var bool */
public $capital;
- /* var int */
+ /** @var int */
public $population;
- /* var array */
+ /** @var array */
public $regions;
+ /**
+ * @param array $regions
+ */
public function __construct(
string $name,
string $state,
@@ -55,6 +58,9 @@ public function __construct(
$this->regions = $regions;
}
+ /**
+ * @param array $source
+ */
public static function fromArray(array $source): City
{
// implementation of fromArray is excluded for brevity
@@ -72,6 +78,9 @@ public static function fromArray(array $source): City
# [END_EXCLUDE]
}
+ /**
+ * @return array
+ */
public function toArray(): array
{
// implementation of toArray is excluded for brevity
diff --git a/firestore/src/solution_sharded_counter_create.php b/firestore/src/solution_sharded_counter_create.php
index 6cd896a54c..2e69f6e5e9 100644
--- a/firestore/src/solution_sharded_counter_create.php
+++ b/firestore/src/solution_sharded_counter_create.php
@@ -40,7 +40,7 @@ function solution_sharded_counter_create(string $projectId): void
$numShards = 10;
$ref = $db->collection('samples/php/distributedCounters');
for ($i = 0; $i < $numShards; $i++) {
- $doc = $ref->document($i);
+ $doc = $ref->document((string) $i);
$doc->set(['Cnt' => 0]);
}
# [END firestore_solution_sharded_counter_create]
diff --git a/firestore/src/solution_sharded_counter_increment.php b/firestore/src/solution_sharded_counter_increment.php
index b9981a04c0..2107d0df68 100644
--- a/firestore/src/solution_sharded_counter_increment.php
+++ b/firestore/src/solution_sharded_counter_increment.php
@@ -45,8 +45,8 @@ function solution_sharded_counter_increment(string $projectId): void
foreach ($docCollection as $doc) {
$numShards++;
}
- $shardIdx = random_int(0, $numShards - 1);
- $doc = $ref->document($shardIdx);
+ $shardIdx = random_int(0, max(1, $numShards) - 1);
+ $doc = $ref->document((string) $shardIdx);
$doc->update([
['path' => 'Cnt', 'value' => FieldValue::increment(1)]
]);
diff --git a/iap/src/validate_jwt.php b/iap/src/validate_jwt.php
index 91c53e0fbe..73e1722925 100644
--- a/iap/src/validate_jwt.php
+++ b/iap/src/validate_jwt.php
@@ -33,18 +33,19 @@
* @param string $cloudProjectNumber The project *number* for your Google
* Cloud project. This is returned by 'gcloud projects describe $PROJECT_ID',
* or in the Project Info card in Cloud Console.
- * @param string $cloud_project Your Google Cloud Project ID.
- *
- * @return (user_id, user_email).
+ * @param string $cloudProjectId Your Google Cloud Project ID.
*/
-function validate_jwt_from_app_engine($iapJwt, $cloudProjectNumber, $cloudProjectId)
-{
+function validate_jwt_from_app_engine(
+ string $iapJwt,
+ string $cloudProjectNumber,
+ string $cloudProjectId
+): void {
$expectedAudience = sprintf(
'/projects/%s/apps/%s',
$cloudProjectNumber,
$cloudProjectId
);
- return validate_jwt($iapJwt, $expectedAudience);
+ validate_jwt($iapJwt, $expectedAudience);
}
/**
@@ -58,8 +59,11 @@ function validate_jwt_from_app_engine($iapJwt, $cloudProjectNumber, $cloudProjec
* application. See https://cloud.google.com/iap/docs/signed-headers-howto
* for details on how to get this value.
*/
-function validate_jwt_from_compute_engine($iapJwt, $cloudProjectNumber, $backendServiceId)
-{
+function validate_jwt_from_compute_engine(
+ string $iapJwt,
+ string $cloudProjectNumber,
+ string $backendServiceId
+): void {
$expectedAudience = sprintf(
'/projects/%s/global/backendServices/%s',
$cloudProjectNumber,
@@ -76,7 +80,7 @@ function validate_jwt_from_compute_engine($iapJwt, $cloudProjectNumber, $backend
* App Engine: /projects/{PROJECT_NUMBER}/apps/{PROJECT_ID}
* Compute Engine: /projects/{PROJECT_NUMBER}/global/backendServices/{BACKEND_SERVICE_ID}
*/
-function validate_jwt($iapJwt, $expectedAudience)
+function validate_jwt(string $iapJwt, string $expectedAudience): void
{
// Validate the signature using the IAP cert URL.
$token = new AccessToken();
@@ -85,7 +89,8 @@ function validate_jwt($iapJwt, $expectedAudience)
]);
if (!$jwt) {
- return print('Failed to validate JWT: Invalid JWT');
+ print('Failed to validate JWT: Invalid JWT');
+ return;
}
// Validate token by checking issuer and audience fields.
diff --git a/kms/src/create_key_asymmetric_decrypt.php b/kms/src/create_key_asymmetric_decrypt.php
index e33da5fdc3..4ad5f4df62 100644
--- a/kms/src/create_key_asymmetric_decrypt.php
+++ b/kms/src/create_key_asymmetric_decrypt.php
@@ -32,7 +32,7 @@ function create_key_asymmetric_decrypt(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-asymmetric-decrypt-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_asymmetric_sign.php b/kms/src/create_key_asymmetric_sign.php
index 65c632cafd..c5de6a5b83 100644
--- a/kms/src/create_key_asymmetric_sign.php
+++ b/kms/src/create_key_asymmetric_sign.php
@@ -32,7 +32,7 @@ function create_key_asymmetric_sign(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-asymmetric-signing-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_hsm.php b/kms/src/create_key_hsm.php
index 37f284ff1d..5266615bb0 100644
--- a/kms/src/create_key_hsm.php
+++ b/kms/src/create_key_hsm.php
@@ -33,7 +33,7 @@ function create_key_hsm(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-hsm-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_labels.php b/kms/src/create_key_labels.php
index 6d77bc9e5b..461adc19e0 100644
--- a/kms/src/create_key_labels.php
+++ b/kms/src/create_key_labels.php
@@ -31,7 +31,7 @@ function create_key_labels(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-key-with-labels'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_mac.php b/kms/src/create_key_mac.php
index e0ada08bda..1e5f16eddf 100644
--- a/kms/src/create_key_mac.php
+++ b/kms/src/create_key_mac.php
@@ -32,7 +32,7 @@ function create_key_mac(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-mac-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_ring.php b/kms/src/create_key_ring.php
index efd1526edf..d73964ec49 100644
--- a/kms/src/create_key_ring.php
+++ b/kms/src/create_key_ring.php
@@ -27,7 +27,7 @@ function create_key_ring(
string $projectId = 'my-project',
string $locationId = 'us-east1',
string $id = 'my-key-ring'
-) {
+): KeyRing {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_rotation_schedule.php b/kms/src/create_key_rotation_schedule.php
index 2e7c077671..81d662be1b 100644
--- a/kms/src/create_key_rotation_schedule.php
+++ b/kms/src/create_key_rotation_schedule.php
@@ -33,7 +33,7 @@ function create_key_rotation_schedule(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-key-with-rotation-schedule'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_symmetric_encrypt_decrypt.php b/kms/src/create_key_symmetric_encrypt_decrypt.php
index a460cf12d2..78288fa1ae 100644
--- a/kms/src/create_key_symmetric_encrypt_decrypt.php
+++ b/kms/src/create_key_symmetric_encrypt_decrypt.php
@@ -31,7 +31,7 @@ function create_key_symmetric_encrypt_decrypt(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $id = 'my-symmetric-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/create_key_version.php b/kms/src/create_key_version.php
index 13bd25a63d..81101a4924 100644
--- a/kms/src/create_key_version.php
+++ b/kms/src/create_key_version.php
@@ -28,7 +28,7 @@ function create_key_version(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key'
-) {
+): CryptoKeyVersion {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/disable_key_version.php b/kms/src/disable_key_version.php
index 68272b2294..c7131c4e1f 100644
--- a/kms/src/disable_key_version.php
+++ b/kms/src/disable_key_version.php
@@ -31,7 +31,7 @@ function disable_key_version(
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key',
string $versionId = '123'
-) {
+): CryptoKeyVersion {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/enable_key_version.php b/kms/src/enable_key_version.php
index c934c2f0aa..dc8ac54faa 100644
--- a/kms/src/enable_key_version.php
+++ b/kms/src/enable_key_version.php
@@ -31,7 +31,7 @@ function enable_key_version(
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key',
string $versionId = '123'
-) {
+): CryptoKeyVersion {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/encrypt_asymmetric.php b/kms/src/encrypt_asymmetric.php
index 1f2ea37e7c..39a99d14a5 100644
--- a/kms/src/encrypt_asymmetric.php
+++ b/kms/src/encrypt_asymmetric.php
@@ -27,7 +27,7 @@ function encrypt_asymmetric(
string $keyId = 'my-key',
string $versionId = '123',
string $plaintext = '...'
-) {
+): void {
// PHP has limited support for asymmetric encryption operations.
// Specifically, openssl_public_encrypt() does not allow customizing
// algorithms or padding. Thus, it is not currently possible to use PHP
diff --git a/kms/src/iam_remove_member.php b/kms/src/iam_remove_member.php
index 6cb56ebaab..27d24f6d4a 100644
--- a/kms/src/iam_remove_member.php
+++ b/kms/src/iam_remove_member.php
@@ -30,7 +30,7 @@ function iam_remove_member(
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key',
string $member = 'user:foo@example.com'
-) {
+): Policy {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/update_key_add_rotation.php b/kms/src/update_key_add_rotation.php
index 92a82c39cd..3ea8e1c269 100644
--- a/kms/src/update_key_add_rotation.php
+++ b/kms/src/update_key_add_rotation.php
@@ -31,7 +31,7 @@ function update_key_add_rotation(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/update_key_remove_labels.php b/kms/src/update_key_remove_labels.php
index 6f17cea24a..8a20c9c64b 100644
--- a/kms/src/update_key_remove_labels.php
+++ b/kms/src/update_key_remove_labels.php
@@ -29,7 +29,7 @@ function update_key_remove_labels(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/update_key_remove_rotation.php b/kms/src/update_key_remove_rotation.php
index 0c8c048de4..9e89d5a9b9 100644
--- a/kms/src/update_key_remove_rotation.php
+++ b/kms/src/update_key_remove_rotation.php
@@ -29,7 +29,7 @@ function update_key_remove_rotation(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/update_key_update_labels.php b/kms/src/update_key_update_labels.php
index a5fe76f35e..41fc02e916 100644
--- a/kms/src/update_key_update_labels.php
+++ b/kms/src/update_key_update_labels.php
@@ -29,7 +29,7 @@ function update_key_update_labels(
string $locationId = 'us-east1',
string $keyRingId = 'my-key-ring',
string $keyId = 'my-key'
-) {
+): CryptoKey {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/verify_asymmetric_ec.php b/kms/src/verify_asymmetric_ec.php
index e065b3edd6..1d1871836d 100644
--- a/kms/src/verify_asymmetric_ec.php
+++ b/kms/src/verify_asymmetric_ec.php
@@ -30,7 +30,7 @@ function verify_asymmetric_ec(
string $versionId = '123',
string $message = '...',
string $signature = '...'
-) {
+): bool {
// Create the Cloud KMS client.
$client = new KeyManagementServiceClient();
diff --git a/kms/src/verify_asymmetric_rsa.php b/kms/src/verify_asymmetric_rsa.php
index 1aa675964f..0ca5067a02 100644
--- a/kms/src/verify_asymmetric_rsa.php
+++ b/kms/src/verify_asymmetric_rsa.php
@@ -28,7 +28,7 @@ function verify_asymmetric_rsa(
string $versionId = '123',
string $message = '...',
string $signature = '...'
-) {
+): void {
// PHP has limited support for asymmetric encryption operations.
// Specifically, openssl_public_encrypt() does not allow customizing
// algorithms or padding. Thus, it is not currently possible to use PHP
diff --git a/logging/src/update_sink.php b/logging/src/update_sink.php
index 7bbe7f6c37..2726ed2303 100644
--- a/logging/src/update_sink.php
+++ b/logging/src/update_sink.php
@@ -24,7 +24,7 @@
* Update a log sink.
*
* @param string $projectId
- * @param string sinkName
+ * @param string $sinkName
* @param string $filterString
*/
function update_sink($projectId, $sinkName, $filterString)
diff --git a/logging/src/write_with_monolog_logger.php b/logging/src/write_with_monolog_logger.php
index caa5c84a99..92438a9e37 100644
--- a/logging/src/write_with_monolog_logger.php
+++ b/logging/src/write_with_monolog_logger.php
@@ -29,7 +29,8 @@
* @param string $projectId The Google project ID.
* @param string $loggerName The name of the logger.
* @param string $message The log message.
- * @param int $level
+ * @param string $level
+ * @phpstan-param LogLevel::* $level
*/
function write_with_monolog_logger(
string $projectId,
diff --git a/logging/src/write_with_psr_logger.php b/logging/src/write_with_psr_logger.php
index 29ebf7552c..037702e873 100644
--- a/logging/src/write_with_psr_logger.php
+++ b/logging/src/write_with_psr_logger.php
@@ -27,6 +27,8 @@
* @param string $projectId The Google project ID.
* @param string $loggerName The name of the logger.
* @param string $message The log message.
+ * @param string $level The log level.
+ * @phpstan-param LogLevel::* $level
*/
function write_with_psr_logger(
string $projectId,
diff --git a/media/transcoder/src/create_job_with_concatenated_inputs.php b/media/transcoder/src/create_job_with_concatenated_inputs.php
index 9365344730..1434d7008a 100644
--- a/media/transcoder/src/create_job_with_concatenated_inputs.php
+++ b/media/transcoder/src/create_job_with_concatenated_inputs.php
@@ -53,14 +53,14 @@
function create_job_with_concatenated_inputs($projectId, $location, $input1Uri, $startTimeInput1, $endTimeInput1, $input2Uri, $startTimeInput2, $endTimeInput2, $outputUri)
{
$startTimeInput1Sec = (int) floor(abs($startTimeInput1));
- $startTimeInput1Nanos = (int) (1000000000 * bcsub(abs($startTimeInput1), floor(abs($startTimeInput1)), 4));
+ $startTimeInput1Nanos = (int) (1000000000 * bcsub((string) abs($startTimeInput1), (string) floor(abs($startTimeInput1)), 4));
$endTimeInput1Sec = (int) floor(abs($endTimeInput1));
- $endTimeInput1Nanos = (int) (1000000000 * bcsub(abs($endTimeInput1), floor(abs($endTimeInput1)), 4));
+ $endTimeInput1Nanos = (int) (1000000000 * bcsub((string) abs($endTimeInput1), (string) floor(abs($endTimeInput1)), 4));
$startTimeInput2Sec = (int) floor(abs($startTimeInput2));
- $startTimeInput2Nanos = (int) (1000000000 * bcsub(abs($startTimeInput2), floor(abs($startTimeInput2)), 4));
+ $startTimeInput2Nanos = (int) (1000000000 * bcsub((string) abs($startTimeInput2), (string) floor(abs($startTimeInput2)), 4));
$endTimeInput2Sec = (int) floor(abs($endTimeInput2));
- $endTimeInput2Nanos = (int) (1000000000 * bcsub(abs($endTimeInput2), floor(abs($endTimeInput2)), 4));
+ $endTimeInput2Nanos = (int) (1000000000 * bcsub((string) abs($endTimeInput2), (string) floor(abs($endTimeInput2)), 4));
// Instantiate a client.
$transcoderServiceClient = new TranscoderServiceClient();
diff --git a/media/videostitcher/src/create_cdn_key.php b/media/videostitcher/src/create_cdn_key.php
index 4dba07114c..35a733d4c5 100644
--- a/media/videostitcher/src/create_cdn_key.php
+++ b/media/videostitcher/src/create_cdn_key.php
@@ -46,7 +46,7 @@
* https://cloud.google.com/video-stitcher/docs/how-to/managing-cdn-keys#create-private-key-media-cdn
* for more information. For a Cloud CDN key,
* this is a base64-encoded string secret.
- * @param boolean $isMediaCdn If true, create a Media CDN key. If false,
+ * @param bool $isMediaCdn If true, create a Media CDN key. If false,
* create a Cloud CDN key.
*/
function create_cdn_key(
@@ -56,7 +56,7 @@ function create_cdn_key(
string $hostname,
string $keyName,
string $privateKey,
- string $isMediaCdn
+ bool $isMediaCdn
): void {
// Instantiate a client.
$stitcherClient = new VideoStitcherServiceClient();
diff --git a/media/videostitcher/src/update_cdn_key.php b/media/videostitcher/src/update_cdn_key.php
index ba86c2ecd9..a5fabc9ae8 100644
--- a/media/videostitcher/src/update_cdn_key.php
+++ b/media/videostitcher/src/update_cdn_key.php
@@ -47,7 +47,7 @@
* https://cloud.google.com/video-stitcher/docs/how-to/managing-cdn-keys#create-private-key-media-cdn
* for more information. For a Cloud CDN key,
* this is a base64-encoded string secret.
- * @param boolean $isMediaCdn If true, update a Media CDN key. If false,
+ * @param bool $isMediaCdn If true, update a Media CDN key. If false,
* update a Cloud CDN key.
*/
function update_cdn_key(
@@ -57,7 +57,7 @@ function update_cdn_key(
string $hostname,
string $keyName,
string $privateKey,
- string $isMediaCdn
+ bool $isMediaCdn
): void {
// Instantiate a client.
$stitcherClient = new VideoStitcherServiceClient();
diff --git a/monitoring/src/alert_create_channel.php b/monitoring/src/alert_create_channel.php
index 62d449b0cc..c5b4af5856 100644
--- a/monitoring/src/alert_create_channel.php
+++ b/monitoring/src/alert_create_channel.php
@@ -30,7 +30,7 @@
/**
* @param string $projectId Your project ID
*/
-function alert_create_channel($projectId)
+function alert_create_channel(string $projectId): void
{
$channelClient = new NotificationChannelServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/alert_delete_channel.php b/monitoring/src/alert_delete_channel.php
index 962284262b..0f41860f06 100644
--- a/monitoring/src/alert_delete_channel.php
+++ b/monitoring/src/alert_delete_channel.php
@@ -28,8 +28,9 @@
/**
* @param string $projectId Your project ID
+ * @param string $channelId
*/
-function alert_delete_channel($projectId, $channelId)
+function alert_delete_channel(string $projectId, string $channelId): void
{
$channelClient = new NotificationChannelServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/alert_replace_channels.php b/monitoring/src/alert_replace_channels.php
index 666937cbdf..1c19a35d86 100644
--- a/monitoring/src/alert_replace_channels.php
+++ b/monitoring/src/alert_replace_channels.php
@@ -32,9 +32,9 @@
/**
* @param string $projectId Your project ID
* @param string $alertPolicyId Your alert policy id ID
- * @param array $channelIds array of channel IDs
+ * @param string[] $channelIds array of channel IDs
*/
-function alert_replace_channels($projectId, $alertPolicyId, array $channelIds)
+function alert_replace_channels(string $projectId, string $alertPolicyId, array $channelIds): void
{
$alertClient = new AlertPolicyServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/alert_restore_policies.php b/monitoring/src/alert_restore_policies.php
index 5c7857ab36..b7da148fb3 100644
--- a/monitoring/src/alert_restore_policies.php
+++ b/monitoring/src/alert_restore_policies.php
@@ -36,7 +36,7 @@
/**
* @param string $projectId Your project ID
*/
-function alert_restore_policies($projectId)
+function alert_restore_policies(string $projectId): void
{
$alertClient = new AlertPolicyServiceClient([
'projectId' => $projectId,
@@ -48,14 +48,14 @@ function alert_restore_policies($projectId)
print('Loading alert policies and notification channels from backup.json.' . PHP_EOL);
$projectName = $alertClient->projectName($projectId);
- $record = json_decode(file_get_contents('backup.json'), true);
+ $record = json_decode((string) file_get_contents('backup.json'), true);
$isSameProject = $projectName == $record['project_name'];
# Convert dicts to AlertPolicies.
$policies = [];
foreach ($record['policies'] as $policyArray) {
$policy = new AlertPolicy();
- $policy->mergeFromJsonString(json_encode($policyArray));
+ $policy->mergeFromJsonString((string) json_encode($policyArray));
$policies[] = $policy;
}
@@ -63,7 +63,7 @@ function alert_restore_policies($projectId)
$channels = [];
foreach (array_filter($record['channels']) as $channelArray) {
$channel = new NotificationChannel();
- $channel->mergeFromJsonString(json_encode($channelArray));
+ $channel->mergeFromJsonString((string) json_encode($channelArray));
$channels[] = $channel;
}
@@ -108,8 +108,8 @@ function alert_restore_policies($projectId)
foreach ($policies as $policy) {
printf('Updating policy %s' . PHP_EOL, $policy->getDisplayName());
# These two fields cannot be set directly, so clear them.
- $policy->setCreationRecord(null);
- $policy->setMutationRecord(null);
+ $policy->clearCreationRecord();
+ $policy->clearMutationRecord();
$notificationChannels = $policy->getNotificationChannels();
diff --git a/monitoring/src/list_uptime_check_ips.php b/monitoring/src/list_uptime_check_ips.php
index 4bc08e38cf..b8e90e807b 100644
--- a/monitoring/src/list_uptime_check_ips.php
+++ b/monitoring/src/list_uptime_check_ips.php
@@ -32,7 +32,7 @@
* list_uptime_check_ips($projectId);
* ```
*/
-function list_uptime_check_ips($projectId)
+function list_uptime_check_ips(string $projectId): void
{
$uptimeCheckClient = new UptimeCheckServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/list_uptime_checks.php b/monitoring/src/list_uptime_checks.php
index 4fe94bac99..d3128f03af 100644
--- a/monitoring/src/list_uptime_checks.php
+++ b/monitoring/src/list_uptime_checks.php
@@ -32,7 +32,7 @@
* list_uptime_checks($projectId);
* ```
*/
-function list_uptime_checks($projectId)
+function list_uptime_checks(string $projectId): void
{
$uptimeCheckClient = new UptimeCheckServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/read_timeseries_align.php b/monitoring/src/read_timeseries_align.php
index cbf16470e1..516309b749 100644
--- a/monitoring/src/read_timeseries_align.php
+++ b/monitoring/src/read_timeseries_align.php
@@ -40,7 +40,7 @@
*
* @param string $projectId Your project ID
*/
-function read_timeseries_align($projectId, $minutesAgo = 20)
+function read_timeseries_align(string $projectId, int $minutesAgo = 20): void
{
$metrics = new MetricServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/read_timeseries_fields.php b/monitoring/src/read_timeseries_fields.php
index 096c67e01c..92db07e61a 100644
--- a/monitoring/src/read_timeseries_fields.php
+++ b/monitoring/src/read_timeseries_fields.php
@@ -37,7 +37,7 @@
*
* @param string $projectId Your project ID
*/
-function read_timeseries_fields($projectId, $minutesAgo = 20)
+function read_timeseries_fields(string $projectId, int $minutesAgo = 20): void
{
$metrics = new MetricServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/read_timeseries_reduce.php b/monitoring/src/read_timeseries_reduce.php
index 1bad97657a..aa125dca09 100644
--- a/monitoring/src/read_timeseries_reduce.php
+++ b/monitoring/src/read_timeseries_reduce.php
@@ -39,7 +39,7 @@
*
* @param string $projectId Your project ID
*/
-function read_timeseries_reduce($projectId, $minutesAgo = 20)
+function read_timeseries_reduce(string $projectId, int $minutesAgo = 20): void
{
$metrics = new MetricServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/read_timeseries_simple.php b/monitoring/src/read_timeseries_simple.php
index 500e6e6e64..934012d974 100644
--- a/monitoring/src/read_timeseries_simple.php
+++ b/monitoring/src/read_timeseries_simple.php
@@ -37,7 +37,7 @@
*
* @param string $projectId Your project ID
*/
-function read_timeseries_simple($projectId, $minutesAgo = 20)
+function read_timeseries_simple(string $projectId, int $minutesAgo = 20): void
{
$metrics = new MetricServiceClient([
'projectId' => $projectId,
diff --git a/monitoring/src/update_uptime_check.php b/monitoring/src/update_uptime_check.php
index 5538350ff2..6aa2feaeeb 100644
--- a/monitoring/src/update_uptime_check.php
+++ b/monitoring/src/update_uptime_check.php
@@ -33,8 +33,12 @@
* update_uptime_checks($projectId);
* ```
*/
-function update_uptime_checks($projectId, $configName, $newDisplayName = null, $newHttpCheckPath = null)
-{
+function update_uptime_checks(
+ string $projectId,
+ string $configName,
+ string $newDisplayName = null,
+ string $newHttpCheckPath = null
+): void {
$uptimeCheckClient = new UptimeCheckServiceClient([
'projectId' => $projectId,
]);
@@ -46,11 +50,13 @@ function update_uptime_checks($projectId, $configName, $newDisplayName = null, $
$uptimeCheck->setDisplayName($newDisplayName);
}
if ($newHttpCheckPath) {
- $fieldMask->getPaths()[] = 'http_check.path';
+ $paths = $fieldMask->getPaths()[] = 'http_check.path';
$uptimeCheck->getHttpCheck()->setPath($newHttpCheckPath);
}
- $uptimeCheckClient->updateUptimeCheckConfig($uptimeCheck, $fieldMask);
+ $uptimeCheckClient->updateUptimeCheckConfig($uptimeCheck, [
+ 'updateMask' => $fieldMask
+ ]);
print($uptimeCheck->serializeToString() . PHP_EOL);
}
diff --git a/pubsub/api/src/create_avro_schema.php b/pubsub/api/src/create_avro_schema.php
index 54ed913505..2fd09268f6 100644
--- a/pubsub/api/src/create_avro_schema.php
+++ b/pubsub/api/src/create_avro_schema.php
@@ -24,7 +24,6 @@
# [START pubsub_create_avro_schema]
use Google\Cloud\PubSub\PubSubClient;
-use Google\Cloud\PubSub\V1\Schema\Type;
/**
* Create a Schema with an AVRO definition.
@@ -33,14 +32,14 @@
* @param string $schemaId
* @param string $avscFile
*/
-function create_avro_schema($projectId, $schemaId, $avscFile)
+function create_avro_schema(string $projectId, string $schemaId, string $avscFile): void
{
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);
- $definition = file_get_contents($avscFile);
- $schema = $pubsub->createSchema($schemaId, Type::AVRO, $definition);
+ $definition = (string) file_get_contents($avscFile);
+ $schema = $pubsub->createSchema($schemaId, 'AVRO', $definition);
printf('Schema %s created.', $schema->name());
}
diff --git a/pubsub/api/src/create_bigquery_subscription.php b/pubsub/api/src/create_bigquery_subscription.php
index 6c3e54b8c8..3e168e351b 100644
--- a/pubsub/api/src/create_bigquery_subscription.php
+++ b/pubsub/api/src/create_bigquery_subscription.php
@@ -33,7 +33,7 @@
* @param string $projectId The Google project ID.
* @param string $topicName The Pub/Sub topic name.
* @param string $subscriptionName The Pub/Sub subscription name.
- * @param string $tableName The BigQuery table to which to write.
+ * @param string $table The BigQuery table to which to write.
*/
function create_bigquery_subscription($projectId, $topicName, $subscriptionName, $table)
{
diff --git a/pubsub/api/src/create_proto_schema.php b/pubsub/api/src/create_proto_schema.php
index b6e5b3b93e..22b4f5b5ab 100644
--- a/pubsub/api/src/create_proto_schema.php
+++ b/pubsub/api/src/create_proto_schema.php
@@ -24,7 +24,6 @@
# [START pubsub_create_proto_schema]
use Google\Cloud\PubSub\PubSubClient;
-use Google\Cloud\PubSub\V1\Schema\Type;
/**
* Create a Schema with an Protocol Buffer definition.
@@ -39,8 +38,8 @@ function create_proto_schema($projectId, $schemaId, $protoFile)
'projectId' => $projectId,
]);
- $definition = file_get_contents($protoFile);
- $schema = $pubsub->createSchema($schemaId, Type::PROTOCOL_BUFFER, $definition);
+ $definition = (string) file_get_contents($protoFile);
+ $schema = $pubsub->createSchema($schemaId, 'PROTOCOL_BUFFER', $definition);
printf('Schema %s created.', $schema->name());
}
diff --git a/pubsub/api/src/create_subscription_with_filter.php b/pubsub/api/src/create_subscription_with_filter.php
index fcd6436ce5..8753530bca 100644
--- a/pubsub/api/src/create_subscription_with_filter.php
+++ b/pubsub/api/src/create_subscription_with_filter.php
@@ -34,8 +34,12 @@
* @param string $subscriptionName The Pub/Sub subscription name.
* @param string $filter The Pub/Sub subscription filter.
*/
-function create_subscription_with_filter($projectId, $topicName, $subscriptionName, $filter)
-{
+function create_subscription_with_filter(
+ string $projectId,
+ string $topicName,
+ string $subscriptionName,
+ string $filter
+): void {
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);
diff --git a/pubsub/api/src/dead_letter_update_subscription.php b/pubsub/api/src/dead_letter_update_subscription.php
index 655b4c07d8..da96ec4aba 100644
--- a/pubsub/api/src/dead_letter_update_subscription.php
+++ b/pubsub/api/src/dead_letter_update_subscription.php
@@ -33,8 +33,12 @@
* @param string $topicName The Pub/Sub topic name.
* @param string $deadLetterTopicName The Pub/Sub topic to use for dead letter policy.
*/
-function dead_letter_update_subscription($projectId, $topicName, $subscriptionName, $deadLetterTopicName)
-{
+function dead_letter_update_subscription(
+ string $projectId,
+ string $topicName,
+ string $subscriptionName,
+ string $deadLetterTopicName
+): void {
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);
diff --git a/pubsub/api/src/publish_avro_records.php b/pubsub/api/src/publish_avro_records.php
index bd68219c9e..e8f1f3a559 100644
--- a/pubsub/api/src/publish_avro_records.php
+++ b/pubsub/api/src/publish_avro_records.php
@@ -39,7 +39,6 @@
* @param string $projectId
* @param string $topicId
* @param string $definitionFile
- * @return void
*/
function publish_avro_records($projectId, $topicId, $definitionFile)
{
@@ -47,7 +46,7 @@ function publish_avro_records($projectId, $topicId, $definitionFile)
'projectId' => $projectId,
]);
- $definition = file_get_contents($definitionFile);
+ $definition = (string) file_get_contents($definitionFile);
$messageData = [
'name' => 'Alaska',
diff --git a/pubsub/api/src/pubsub_client.php b/pubsub/api/src/pubsub_client.php
index 8f35a5eeb8..f0444e0519 100644
--- a/pubsub/api/src/pubsub_client.php
+++ b/pubsub/api/src/pubsub_client.php
@@ -23,6 +23,8 @@
namespace Google\Cloud\Samples\PubSub;
+$projectId = '';
+
/**
* This file is to be used as an example only!
*
diff --git a/spanner/src/delete_data_with_dml.php b/spanner/src/delete_data_with_dml.php
index 7ba0cef5c9..e2435a4329 100644
--- a/spanner/src/delete_data_with_dml.php
+++ b/spanner/src/delete_data_with_dml.php
@@ -39,7 +39,7 @@ function delete_data_with_dml(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
"DELETE FROM Singers WHERE FirstName = 'Alice'");
$t->commit();
diff --git a/spanner/src/get_commit_stats.php b/spanner/src/get_commit_stats.php
index 9c0eceefac..5c36ceb71b 100644
--- a/spanner/src/get_commit_stats.php
+++ b/spanner/src/get_commit_stats.php
@@ -43,7 +43,7 @@ function get_commit_stats(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $commitStats = $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $commitStats = $database->runTransaction(function (Transaction $t) {
$t->updateBatch('Albums', [
[
'SingerId' => 1,
diff --git a/spanner/src/insert_data_with_dml.php b/spanner/src/insert_data_with_dml.php
index 95e5faf5d2..a272042671 100644
--- a/spanner/src/insert_data_with_dml.php
+++ b/spanner/src/insert_data_with_dml.php
@@ -46,7 +46,7 @@ function insert_data_with_dml(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
'INSERT Singers (SingerId, FirstName, LastName) '
. " VALUES (10, 'Virginia', 'Watson')");
diff --git a/spanner/src/list_instance_config_operations.php b/spanner/src/list_instance_config_operations.php
index 732566f3ee..731516c63d 100644
--- a/spanner/src/list_instance_config_operations.php
+++ b/spanner/src/list_instance_config_operations.php
@@ -33,7 +33,7 @@
* list_instance_config_operations();
* ```
*/
-function list_instance_config_operations()
+function list_instance_config_operations(): void
{
$spanner = new SpannerClient();
diff --git a/spanner/src/list_instance_configs.php b/spanner/src/list_instance_configs.php
index f12c1c81e7..e902daeec5 100644
--- a/spanner/src/list_instance_configs.php
+++ b/spanner/src/list_instance_configs.php
@@ -37,8 +37,10 @@ function list_instance_configs(): void
{
$spanner = new SpannerClient();
foreach ($spanner->instanceConfigurations() as $config) {
- printf('Available leader options for instance config %s: %s' . PHP_EOL,
- $config->info()['displayName'], $config->info()['leaderOptions']
+ printf(
+ 'Available leader options for instance config %s: %s' . PHP_EOL,
+ $config->info()['displayName'],
+ $config->info()['leaderOptions']
);
}
}
diff --git a/spanner/src/pg_numeric_data_type.php b/spanner/src/pg_numeric_data_type.php
index 76124eaa94..483dcb162b 100644
--- a/spanner/src/pg_numeric_data_type.php
+++ b/spanner/src/pg_numeric_data_type.php
@@ -71,7 +71,7 @@ function pg_numeric_data_type(string $instanceId, string $databaseId, string $ta
printf('Inserted %d venue(s).' . PHP_EOL, $count);
});
- $database->runTransaction(function (Transaction $t) use ($spanner, $sql) {
+ $database->runTransaction(function (Transaction $t) use ($sql) {
$count = $t->executeUpdate($sql, [
'parameters' => [
'p1' => 2,
diff --git a/spanner/src/set_transaction_tag.php b/spanner/src/set_transaction_tag.php
index 5499aa0c28..c0c891a9ee 100644
--- a/spanner/src/set_transaction_tag.php
+++ b/spanner/src/set_transaction_tag.php
@@ -43,7 +43,7 @@ function set_transaction_tag(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$t->executeUpdate(
'UPDATE Venues SET Capacity = CAST(Capacity/4 AS INT64) WHERE OutdoorVenue = false',
[
diff --git a/spanner/src/update_data_with_dml.php b/spanner/src/update_data_with_dml.php
index fd5d77358c..7658f74172 100644
--- a/spanner/src/update_data_with_dml.php
+++ b/spanner/src/update_data_with_dml.php
@@ -50,7 +50,7 @@ function update_data_with_dml(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
'UPDATE Albums '
. 'SET MarketingBudget = MarketingBudget * 2 '
diff --git a/spanner/src/update_data_with_dml_structs.php b/spanner/src/update_data_with_dml_structs.php
index 3431d4de67..139933c2ea 100644
--- a/spanner/src/update_data_with_dml_structs.php
+++ b/spanner/src/update_data_with_dml_structs.php
@@ -49,7 +49,7 @@ function update_data_with_dml_structs(string $instanceId, string $databaseId): v
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$nameValue = (new StructValue)
->add('FirstName', 'Timothy')
->add('LastName', 'Campbell');
diff --git a/spanner/src/update_data_with_dml_timestamp.php b/spanner/src/update_data_with_dml_timestamp.php
index 9297cace6f..12a5532b5a 100644
--- a/spanner/src/update_data_with_dml_timestamp.php
+++ b/spanner/src/update_data_with_dml_timestamp.php
@@ -46,7 +46,7 @@ function update_data_with_dml_timestamp(string $instanceId, string $databaseId):
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
'UPDATE Albums '
. 'SET LastUpdateTime = PENDING_COMMIT_TIMESTAMP() WHERE SingerId = 1');
diff --git a/spanner/src/write_data_with_dml.php b/spanner/src/write_data_with_dml.php
index cfe5f24b59..88ede3ed04 100644
--- a/spanner/src/write_data_with_dml.php
+++ b/spanner/src/write_data_with_dml.php
@@ -46,7 +46,7 @@ function write_data_with_dml(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
'INSERT Singers (SingerId, FirstName, LastName) VALUES '
. "(12, 'Melissa', 'Garcia'), "
diff --git a/spanner/src/write_data_with_dml_transaction.php b/spanner/src/write_data_with_dml_transaction.php
index 500f6b4ddb..7519fc4b69 100644
--- a/spanner/src/write_data_with_dml_transaction.php
+++ b/spanner/src/write_data_with_dml_transaction.php
@@ -51,7 +51,7 @@ function write_data_with_dml_transaction(string $instanceId, string $databaseId)
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
// Transfer marketing budget from one album to another. We do it in a transaction to
// ensure that the transfer is atomic.
$transferAmount = 200000;
diff --git a/spanner/src/write_read_with_dml.php b/spanner/src/write_read_with_dml.php
index e2b62f693e..28ad05e34e 100644
--- a/spanner/src/write_read_with_dml.php
+++ b/spanner/src/write_read_with_dml.php
@@ -46,7 +46,7 @@ function write_read_with_dml(string $instanceId, string $databaseId): void
$instance = $spanner->instance($instanceId);
$database = $instance->database($databaseId);
- $database->runTransaction(function (Transaction $t) use ($spanner) {
+ $database->runTransaction(function (Transaction $t) {
$rowCount = $t->executeUpdate(
'INSERT Singers (SingerId, FirstName, LastName) '
. " VALUES (11, 'Timothy', 'Campbell')");
diff --git a/storage/src/upload_object.php b/storage/src/upload_object.php
index ce1b4d46fb..fb7dd331d0 100644
--- a/storage/src/upload_object.php
+++ b/storage/src/upload_object.php
@@ -39,7 +39,9 @@
function upload_object(string $bucketName, string $objectName, string $source): void
{
$storage = new StorageClient();
- $file = fopen($source, 'r');
+ if (!$file = fopen($source, 'r')) {
+ throw new \InvalidArgumentException('Unable to open file for reading');
+ }
$bucket = $storage->bucket($bucketName);
$object = $bucket->upload($file, [
'name' => $objectName
diff --git a/storage/src/upload_object_from_memory.php b/storage/src/upload_object_from_memory.php
index ecd885dda5..9f11d8b692 100644
--- a/storage/src/upload_object_from_memory.php
+++ b/storage/src/upload_object_from_memory.php
@@ -42,7 +42,9 @@ function upload_object_from_memory(
string $contents
): void {
$storage = new StorageClient();
- $stream = fopen('data://text/plain,' . $contents, 'r');
+ if (!$stream = fopen('data://text/plain,' . $contents, 'r')) {
+ throw new \InvalidArgumentException('Unable to open file for reading');
+ }
$bucket = $storage->bucket($bucketName);
$bucket->upload($stream, [
'name' => $objectName,
diff --git a/storage/src/upload_with_kms_key.php b/storage/src/upload_with_kms_key.php
index 11b43746b9..20f69c7a3c 100644
--- a/storage/src/upload_with_kms_key.php
+++ b/storage/src/upload_with_kms_key.php
@@ -42,7 +42,9 @@
function upload_with_kms_key(string $bucketName, string $objectName, string $source, string $kmsKeyName): void
{
$storage = new StorageClient();
- $file = fopen($source, 'r');
+ if (!$file = fopen($source, 'r')) {
+ throw new \InvalidArgumentException('Unable to open file for reading');
+ }
$bucket = $storage->bucket($bucketName);
$object = $bucket->upload($file, [
'name' => $objectName,
diff --git a/tasks/src/create_http_task.php b/tasks/src/create_http_task.php
index f5cd7d9454..9433f1f2c6 100644
--- a/tasks/src/create_http_task.php
+++ b/tasks/src/create_http_task.php
@@ -27,7 +27,8 @@
if ($argc < 5 || $argc > 6) {
return printf("Usage: php %s PROJECT_ID LOCATION_ID QUEUE_ID URL [PAYLOAD]\n", __FILE__);
}
-list($_, $projectId, $locationId, $queueId, $url, $payload) = $argv;
+list($_, $projectId, $locationId, $queueId, $url) = $argv;
+$payload = $argv[5] ?? '';
# [START cloud_tasks_create_http_task]
use Google\Cloud\Tasks\V2\CloudTasksClient;
@@ -53,7 +54,7 @@
// POST is the default HTTP method, but any HTTP method can be used.
$httpRequest->setHttpMethod(HttpMethod::POST);
// Setting a body value is only compatible with HTTP POST and PUT requests.
-if (isset($payload)) {
+if (!empty($payload)) {
$httpRequest->setBody($payload);
}
diff --git a/testing/composer.json b/testing/composer.json
index 88e64eb382..a39308fd69 100755
--- a/testing/composer.json
+++ b/testing/composer.json
@@ -10,6 +10,7 @@
"phpunit/phpunit": "^9.0",
"friendsofphp/php-cs-fixer": "^3,<3.9",
"composer/semver": "^3.2",
+ "phpstan/phpstan": "^1.10",
"phpspec/prophecy-phpunit": "^2.0"
}
}
diff --git a/testing/phpstan/compute/cloud-client/instances.neon.dist b/testing/phpstan/compute/cloud-client/instances.neon.dist
new file mode 100644
index 0000000000..2a8480e8e8
--- /dev/null
+++ b/testing/phpstan/compute/cloud-client/instances.neon.dist
@@ -0,0 +1,5 @@
+parameters:
+ level: 5
+ treatPhpDocTypesAsCertain: false
+ ignoreErrors:
+ - '#Google\\Cloud\\Compute\\V1\\Gapic\\ProjectsGapicClient::setUsageExportBucket\(\) expects Google\\Cloud\\Compute\\V1\\UsageExportLocation#'
diff --git a/testing/phpstan/default.neon.dist b/testing/phpstan/default.neon.dist
new file mode 100644
index 0000000000..bf3085e4ad
--- /dev/null
+++ b/testing/phpstan/default.neon.dist
@@ -0,0 +1,3 @@
+parameters:
+ level: 5
+ treatPhpDocTypesAsCertain: false
diff --git a/testing/phpstan/pubsub/api.neon.dist b/testing/phpstan/pubsub/api.neon.dist
new file mode 100644
index 0000000000..2b73a2b7e2
--- /dev/null
+++ b/testing/phpstan/pubsub/api.neon.dist
@@ -0,0 +1,8 @@
+parameters:
+ level: 5
+ treatPhpDocTypesAsCertain: false
+ excludePaths:
+ - ../../../pubsub/api/src/data
+ ignoreErrors:
+ - '#Utilities\\StateProto#'
+
diff --git a/testing/run_staticanalysis_check.sh b/testing/run_staticanalysis_check.sh
new file mode 100644
index 0000000000..3db1638a1e
--- /dev/null
+++ b/testing/run_staticanalysis_check.sh
@@ -0,0 +1,106 @@
+#!/bin/bash
+# Copyright 2023 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+if [ "${BASH_DEBUG}" = "true" ]; then
+ set -x
+fi
+
+if [ "${TEST_DIRECTORIES}" = "" ]; then
+ TEST_DIRECTORIES="*"
+fi
+
+SKIP_DIRS=(
+ dialogflow
+ iot
+)
+
+TMP_REPORT_DIR=$(mktemp -d)
+SUCCEEDED_FILE=${TMP_REPORT_DIR}/succeeded
+FAILED_FILE=${TMP_REPORT_DIR}/failed
+SKIPPED_FILE=${TMP_REPORT_DIR}/skipped
+
+# Determine all files changed on this branch
+# (will be empty if running from "main").
+FILES_CHANGED=$(git diff --name-only HEAD origin/main)
+
+# If the label `kokoro:run-all` is added, or if we were not triggered from a Pull
+# Request, run the whole test suite.
+if [ -z "$PULL_REQUEST_NUMBER" ]; then
+ RUN_ALL_TESTS=1
+else
+ labels=$(curl "https://api.github.com/repos/GoogleCloudPlatform/php-docs-samples/issues/$PULL_REQUEST_NUMBER/labels")
+
+ # Check to see if the repo includes the "kokoro:run-all" label
+ if grep -q "kokoro:run-all" <<< $labels; then
+ RUN_ALL_TESTS=1
+ else
+ RUN_ALL_TESTS=0
+ fi
+fi
+
+for dir in $(find $TEST_DIRECTORIES -type d -name src -not -path '/*' -not -path 'appengine/*' -not -path '*/vendor/*' -exec dirname {} \;);
+do
+ # Only run tests for samples that have changed.
+ if [ "$RUN_ALL_TESTS" -ne "1" ]; then
+ if ! grep -q ^$dir <<< "$FILES_CHANGED" ; then
+ echo "Skipping tests in $dir (unchanged)"
+ echo "$dir: skipped" >> "${SKIPPED_FILE}"
+ continue
+ fi
+ fi
+ if [[ " ${SKIP_DIRS[@]} " =~ " ${dir} " ]]; then
+ printf "Skipping $dir (explicitly flagged to be skipped)\n\n"
+ echo "$dir: skipped" >> "${SKIPPED_FILE}"
+ continue
+ fi
+ composer update --working-dir=$dir --ignore-platform-reqs -q
+ echo " autoload.php
+ neon="testing/phpstan/default.neon.dist"
+ if [ -f "testing/phpstan/$dir.neon.dist" ]; then
+ neon="testing/phpstan/$dir.neon.dist"
+ fi
+ echo "Running phpstan in \"$dir\" with config \"$neon\""
+ testing/vendor/bin/phpstan analyse $dir/src \
+ --autoload-file=autoload.php \
+ --configuration=$neon
+ if [ $? == 0 ]; then
+ echo "$dir: ok" >> "${SUCCEEDED_FILE}"
+ else
+ echo "$dir: failed" >> "${FAILED_FILE}"
+ fi
+done
+
+set +x
+
+if [ -f "${SUCCEEDED_FILE}" ]; then
+ echo "--------- Succeeded -----------"
+ cat "${SUCCEEDED_FILE}"
+ echo "-------------------------------"
+fi
+
+if [ -f "${SKIPPED_FILE}" ]; then
+ echo "--------- SKIPPED --------------"
+ cat "${SKIPPED_FILE}"
+ echo "--------------------------------"
+ # Report any skips
+fi
+
+if [ -f "${FAILED_FILE}" ]; then
+ echo "--------- Failed --------------"
+ cat "${FAILED_FILE}"
+ echo "-------------------------------"
+ # Report any failure
+ exit 1
+fi
diff --git a/testing/sample_helpers.php b/testing/sample_helpers.php
index 960e35d9bf..da7a4e0bcb 100644
--- a/testing/sample_helpers.php
+++ b/testing/sample_helpers.php
@@ -8,13 +8,13 @@ function execute_sample(string $file, string $namespace, ?array $argv)
{
// Return if sample file is not being executed via CLI
if (is_null($argv)) {
- return;
+ return null;
}
// Return if sample file is being included via PHPUnit
$argvFile = array_shift($argv);
if ('.php' != substr($argvFile, -4)) {
- return;
+ return null;
}
// Determine the name of the function to execute
@@ -27,7 +27,7 @@ function execute_sample(string $file, string $namespace, ?array $argv)
|| count($argv) > $functionReflection->getNumberOfParameters()
) {
print(get_usage(basename($file), $functionReflection));
- return;
+ return null;
}
// Require composer autoload for the user
@@ -37,7 +37,7 @@ function execute_sample(string $file, string $namespace, ?array $argv)
'You must run "composer install" in the sample root (%s/)' . PHP_EOL,
$autoloadDir
);
- return;
+ return null;
}
require_once $autoloadFile;
@@ -59,7 +59,7 @@ function execute_sample(string $file, string $namespace, ?array $argv)
return call_user_func_array($functionName, $argv);
}
-function get_usage(string $file, ReflectionFunction $functionReflection)
+function get_usage(string $file, ReflectionFunction $functionReflection): string
{
// Print basic usage
$paramNames = [];
diff --git a/vision/src/detect_face.php b/vision/src/detect_face.php
index cec248b4e4..a423f484d5 100644
--- a/vision/src/detect_face.php
+++ b/vision/src/detect_face.php
@@ -68,7 +68,7 @@ function detect_face(string $path, string $outFile = null)
# [START vision_face_detection_tutorial_process_response]
# draw box around faces
- if ($faces && $outFile) {
+ if ($faces->count() && $outFile) {
$imageCreateFunc = [
'png' => 'imagecreatefrompng',
'gd' => 'imagecreatefromgd',
diff --git a/vision/src/detect_label.php b/vision/src/detect_label.php
index 678145e2b1..f88c2f8ae1 100644
--- a/vision/src/detect_label.php
+++ b/vision/src/detect_label.php
@@ -32,7 +32,7 @@ function detect_label(string $path)
$response = $imageAnnotator->labelDetection($image);
$labels = $response->getLabelAnnotations();
- if ($labels) {
+ if ($labels->count()) {
print('Labels:' . PHP_EOL);
foreach ($labels as $label) {
print($label->getDescription() . PHP_EOL);
diff --git a/vision/src/detect_label_gcs.php b/vision/src/detect_label_gcs.php
index ca8d5744bb..ad56abe81b 100644
--- a/vision/src/detect_label_gcs.php
+++ b/vision/src/detect_label_gcs.php
@@ -31,7 +31,7 @@ function detect_label_gcs(string $path)
$response = $imageAnnotator->labelDetection($path);
$labels = $response->getLabelAnnotations();
- if ($labels) {
+ if ($labels->count()) {
print('Labels:' . PHP_EOL);
foreach ($labels as $label) {
print($label->getDescription() . PHP_EOL);
diff --git a/vision/src/detect_pdf_gcs.php b/vision/src/detect_pdf_gcs.php
index 2082ac356b..a0d73f1118 100644
--- a/vision/src/detect_pdf_gcs.php
+++ b/vision/src/detect_pdf_gcs.php
@@ -31,7 +31,7 @@
/**
* @param string $path GCS path to the document, e.g. "gs://path/to/your/document.pdf"
- * @param string $outFile GCS path to store the results, e.g. "gs://path/to/store/results/"
+ * @param string $output GCS path to store the results, e.g. "gs://path/to/store/results/"
*/
function detect_pdf_gcs(string $path, string $output)
{
diff --git a/vision/src/detect_web_with_geo_metadata.php b/vision/src/detect_web_with_geo_metadata.php
index 55d4751db5..019887942b 100644
--- a/vision/src/detect_web_with_geo_metadata.php
+++ b/vision/src/detect_web_with_geo_metadata.php
@@ -43,7 +43,7 @@ function detect_web_with_geo_metadata(string $path)
$response = $imageAnnotator->webDetection($image, ['imageContext' => $imageContext]);
$web = $response->getWebDetection();
- if ($web && $web->getWebEntities()) {
+ if ($web && $web->getWebEntities()->count()) {
printf('%d web entities found:' . PHP_EOL,
count($web->getWebEntities()));
foreach ($web->getWebEntities() as $entity) {
From cb97568657292bb1c146970faca31a72318d8af4 Mon Sep 17 00:00:00 2001
From: Brent Shaffer
Date: Wed, 4 Oct 2023 10:45:08 -0700
Subject: [PATCH 078/285] chore: fix lint github action (#1925)
* use files changed github action
* fix yaml syntax
* use files instead of dirs
* testing modifying a file
* debug info
* format files changed correctly
* Revert "testing modifying a file"
This reverts commit 22da5ea160c129b7f1dad79c6c2d255d88256641.
* get rid of skipped dir (redundant)
---
.github/workflows/lint.yml | 10 +++++-----
testing/run_staticanalysis_check.sh | 25 ++++++++-----------------
2 files changed, 13 insertions(+), 22 deletions(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index c4ddad101f..901becf7ff 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -22,13 +22,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- with:
- ref: ${{ github.event.pull_request.head.ref }}
- fetch-depth: 5
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
+ - name: Get changed files
+ id: changedFiles
+ uses: tj-actions/changed-files@v39
- uses: jwalton/gh-find-current-pr@v1
id: findPr
with:
@@ -39,5 +39,5 @@ jobs:
git fetch --no-tags --prune --depth=5 origin main
bash testing/run_staticanalysis_check.sh
env:
- PULL_REQUEST_NUMBER: ${{ steps.findPr.outputs.pr }}
-
+ FILES_CHANGED: ${{ steps.changedFiles.outputs.all_changed_files }}
+ PULL_REQUEST_NUMBER: ${{ steps.findPr.outputs.pr }}
\ No newline at end of file
diff --git a/testing/run_staticanalysis_check.sh b/testing/run_staticanalysis_check.sh
index 3db1638a1e..0dd02ceaff 100644
--- a/testing/run_staticanalysis_check.sh
+++ b/testing/run_staticanalysis_check.sh
@@ -17,10 +17,6 @@ if [ "${BASH_DEBUG}" = "true" ]; then
set -x
fi
-if [ "${TEST_DIRECTORIES}" = "" ]; then
- TEST_DIRECTORIES="*"
-fi
-
SKIP_DIRS=(
dialogflow
iot
@@ -29,11 +25,15 @@ SKIP_DIRS=(
TMP_REPORT_DIR=$(mktemp -d)
SUCCEEDED_FILE=${TMP_REPORT_DIR}/succeeded
FAILED_FILE=${TMP_REPORT_DIR}/failed
-SKIPPED_FILE=${TMP_REPORT_DIR}/skipped
-# Determine all files changed on this branch
-# (will be empty if running from "main").
-FILES_CHANGED=$(git diff --name-only HEAD origin/main)
+if [ "${TEST_DIRECTORIES}" = "" ]; then
+ TEST_DIRECTORIES="*"
+fi
+
+if [ "${FILES_CHANGED}" = "" ]; then
+ FILES_CHANGED=""
+fi
+FILES_CHANGED=$(echo $FILES_CHANGED | tr " " "\n")
# If the label `kokoro:run-all` is added, or if we were not triggered from a Pull
# Request, run the whole test suite.
@@ -56,13 +56,11 @@ do
if [ "$RUN_ALL_TESTS" -ne "1" ]; then
if ! grep -q ^$dir <<< "$FILES_CHANGED" ; then
echo "Skipping tests in $dir (unchanged)"
- echo "$dir: skipped" >> "${SKIPPED_FILE}"
continue
fi
fi
if [[ " ${SKIP_DIRS[@]} " =~ " ${dir} " ]]; then
printf "Skipping $dir (explicitly flagged to be skipped)\n\n"
- echo "$dir: skipped" >> "${SKIPPED_FILE}"
continue
fi
composer update --working-dir=$dir --ignore-platform-reqs -q
@@ -90,13 +88,6 @@ if [ -f "${SUCCEEDED_FILE}" ]; then
echo "-------------------------------"
fi
-if [ -f "${SKIPPED_FILE}" ]; then
- echo "--------- SKIPPED --------------"
- cat "${SKIPPED_FILE}"
- echo "--------------------------------"
- # Report any skips
-fi
-
if [ -f "${FAILED_FILE}" ]; then
echo "--------- Failed --------------"
cat "${FAILED_FILE}"
From d98b3ef8a94100f69f97715137a72113af741e94 Mon Sep 17 00:00:00 2001
From: sameer-crest <129392897+sameer-crest@users.noreply.github.com>
Date: Wed, 4 Oct 2023 23:39:41 +0530
Subject: [PATCH 079/285] fix(dlp): corrected the region tags (#1924)
---
dlp/src/inspect_text_file.php | 4 ++--
dlp/src/k_anonymity.php | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/dlp/src/inspect_text_file.php b/dlp/src/inspect_text_file.php
index 5acf13de7c..197401b748 100644
--- a/dlp/src/inspect_text_file.php
+++ b/dlp/src/inspect_text_file.php
@@ -23,7 +23,7 @@
namespace Google\Cloud\Samples\Dlp;
-// [START dlp_inspect_text_file]
+// [START dlp_inspect_file]
use Google\Cloud\Dlp\V2\DlpServiceClient;
use Google\Cloud\Dlp\V2\ContentItem;
use Google\Cloud\Dlp\V2\InfoType;
@@ -81,7 +81,7 @@ function inspect_text_file(string $projectId, string $filepath): void
}
}
}
-// [END dlp_inspect_text_file]
+// [END dlp_inspect_file]
// The following 2 lines are only needed to run the samples
require_once __DIR__ . '/../../testing/sample_helpers.php';
diff --git a/dlp/src/k_anonymity.php b/dlp/src/k_anonymity.php
index 449ad3a7e7..3ab5dce271 100644
--- a/dlp/src/k_anonymity.php
+++ b/dlp/src/k_anonymity.php
@@ -23,7 +23,7 @@
namespace Google\Cloud\Samples\Dlp;
-# [START dlp_k_anomymity]
+# [START dlp_k_anonymity]
use Google\Cloud\Dlp\V2\DlpServiceClient;
use Google\Cloud\Dlp\V2\RiskAnalysisJobConfig;
use Google\Cloud\Dlp\V2\BigQueryTable;
@@ -169,7 +169,7 @@ function ($id) {
print('Unexpected job state. Most likely, the job is either running or has not yet started.');
}
}
-# [END dlp_k_anomymity]
+# [END dlp_k_anonymity]
// The following 2 lines are only needed to run the samples
require_once __DIR__ . '/../../testing/sample_helpers.php';
From 7829067093b0c6c78beb0380080c0db0db47db7c Mon Sep 17 00:00:00 2001
From: Ajumal
Date: Sun, 15 Oct 2023 16:04:02 +0530
Subject: [PATCH 080/285] feat(PubSub): Add CPS to GCS sample (#1874)
---
.kokoro/secrets.sh.enc | Bin 9119 -> 9188 bytes
pubsub/api/composer.json | 2 +-
.../src/create_cloud_storage_subscription.php | 53 ++++++++++++++++++
pubsub/api/test/pubsubTest.php | 25 +++++++++
4 files changed, 79 insertions(+), 1 deletion(-)
create mode 100644 pubsub/api/src/create_cloud_storage_subscription.php
diff --git a/.kokoro/secrets.sh.enc b/.kokoro/secrets.sh.enc
index eaf26147ae4914ad7acfdc3c9370e43d9592336a..8bb4b60e692bb5dd8b3ca2125304d46924885c8e 100644
GIT binary patch
literal 9188
zcmVD5)85G76<98
zlM`1tx-%oUrIXb#4qsqfH5d-`7Y)ICO#`EaB8%jDnezsIuH^f@gtDi;iY3{W?{(z#
zW|+o~PDegpk)*>NY`s*{VUvb4@`$|$g$0Y@uQypmG!e2*lh&ZVG2
zE@9Rw5=ERhfhIp&-S${r=+Os~PSD8+-py<|I!qI^>WS)$F^>o)XTwHJL8EVCkX|&N
zBTR%qNgi;jB{l(|imYiRJ|~N)Mtyv;JX1J{#~Oo^t9@Y-l1GB@sxJhs7HU2geDj7Q
z+1~rl2*7%-zZv+9WSjT&rvckoBQT%$(82FdWzODMtX*@CczP&yBpucpz1FnT>4|SB
zuFU+Z3=tF40ykOPsb0}RM>8sPRG*7sPf{cL3zd7h)y|OTOh}}t{;5$fT|*d2HVP^8u$+@
z;y7`bXPNt07sVwpJ}}mYp_j0Cw&^yxD*s6aBzg{
zH{p$gVG;PCxXu{H-igiX>_lGjIXmGEy-VHE^^@A)kAcLtRT03Q#C(nZW%lY1l<90h
zBh5AIjNeM}NP(@K%Z1nH8D8#n0IfwSbRy3HhwJ@)KfMTE@{DSKKm5dXi_Qw>9}^HA
zp(|o)6bY
zEeMHe6GP0>GC#$~$3w8N==-Dj&oXr@(ks7oqWCWM8o-gde4q&A36X&Ta2|2((^mFFF;Of;Lk%7u5YGNhHNGXxo&u!(
z%DTakhr=B?qVzprEb-^_&kvpYx<{7}b~>>r*w?6Zy=6=GuegqFzbWf#^NB@`F{ncNAt*HxAW$rydL#(A{T2V-piIu|8&;l|SmR0L291wNxO56m(w>Cg40u
z1LVMxYhSm(E#J
zIiMk^-oO#5#khtH9xxpHNCo`mOaiLN$yCH#)^EWjJ)3?25x@pTP=uQ^!|Xfpj^jP3
z$QV~^!u-^NI$;2lW>g>+@vjL4O?o9$jcN(}tdm31QWP1SsjTwERIkAF{G$xa^Bj94
zr=A+#*kA8p|AQvhcd)Z?M!*ah(j&doN+a_(Er7
z6$B6ZXXaJv=(ecUd0OQ#UqOaBuQ7pluc+;4rR?JYQi0i$X6to4MFu6@)v|-(ouI>M
z*_AXC4CT=PFAf@QO05Hk9C{zHpSNvSBy*fwy2Qq=7NZ!{LJf3VIbh2Dq
zhilwR4rf`IKUC??M5CX@3Jm;E-{M}Q?*mhuW1L7&Ipx+>C9+x{HBD}k0&iC?-FA~|
z>{ZFoI4c6N97xb8ea7BbrUC
z^(2_2x3E~uzm^S68+?2RXWhEsA_DTMRnr(@>x&HVd$cg@QSnb^3_w+72B=cVvFX`U
z{D@z_;)MvqAs^xlfx&T@rI6~06uHD=R^km-$99!QKinw~9!;0}=8<<2=F+QQ@H5ae
z@70XT5g~S_Jt+la&ps*{mzL~Z0HG-Pjy5)Ow<7F{C|4)i_Ds{fibQU@76>8&S~>}C
z4qFZ1HJ_JNOaVPFSryOl1e&#Gi1YD_sDUi@Fc|e59QqIP9lZ!cN<*pE
zMcB{jY?-SU9Valu4)X}0W`^g`_u};X+!8S_e|(SO5IrDUsun}tu5?gZIvwkjY-
z;k>K^&SDWpjUrG}Iz8rq{gEgu^!x=JcJU1MnIEPmSEoiFP=SjHwetbBPCvY(>g}_o
zdLOTwOt%y5_n+-Zr{1uP?@s7Gg>090h>Zvs>Z4U>k~6*i<@_CARg*aL)B;9KJZ@3B
zu1O}}RIv4=CBRse{Ark3J)x}%yRE4;c*>kh%W&Tf1l)4#g;!Z2mp65>M>Kq%fXh-s
zM5WjJ7KP(0HK_KWJvUR^EDd6S5+YBOCph7X(_xkwP~g!T;)EFV_?JZv4TfcKA=PG*
zon62>G`S#CYnhGe1`l?ak^eViQswvi!749;=_qMrr)06qfyQb%ou3)q#;saI(>U)x
zKpq^JQA&l|d(MMfZ*1rb7vkRWwHhE&>OVLDzWIsHg)RzUl^dN#sS^4Ks>F0)VU!0N
zglIfd?nd~7Vb)LQ(;)3tMf9ORKQ2g(vfeSX^GsE5tUemTMQ1kE@LaMPtgqTycxd9NAA5HGLTzO76W%#YhTk>o@Opw
zk`SF+Zb`T^LqgcKqGo;iG6JH?s-;=-#aoy$TS6`!wGPWb{Ng`cN{^(82G
zb(LH}63i1n9-yyMi(IFm&%?8|_@u_Ze?m|mgQ#?g5zVaK+X1up_`9X~y%-~HnHtDu
z$JW1&yVhbc*ES122+8OdIt-J3?FY;!ku=d*m5~-=?fJ_}TUt$bGKLlMzzDQS6Rk#L
zL^n{1iwncQDo&joMN&vLx7gB%fB*<>Nc4aYzf6yF4bSsTP2EZ`qDvE8IXNYcC=m60
zH&NT`_|FOp0lra?+Hs`H&Bp{ASkYe(a>$Kpmu!oH!3F@XqD-Wh+)~M_aA0|8;G}&U
zo0HJl4g@zSp1D-4aU3i)Y~9S!KghZY#7S~Ns%co>mWYiP#_Vs-0M@M1wF_o9x7&=y
z7Otc<-*ZCB4rnT3ZKAY~IYolL*>jXerDPy1fK_C}GdNrHc!)McOgfcR(&E^n8
zWwVjg(DxVhyJ$Y&PdZ8t+)XpJEJHHkk#eA#i2`d1GAS}!)c0^NBcSaeWSEkmSt#~1
zpr6K^0e^+Saze8o6UJ=?+d#PXmDr3y{S`^1fchFD1t3J>NG2%E>JXECTBlj_9Kgj_
zCP}&k2atI{6dWS|)76kABh>E;_gX)mgh_y!+?q=O*!Z1Ah0Xlc3;LEEAk_G(+LW?7
zqjS=j#IlU?aq=~VwuG7FZ4Igl5A~}npS>CG1uPRICR@)m5YaB;2#cnxPVP;&7thO?
zt~N~S*2P`uoL*cr`f@!C2zkSlfU}xNbK)s_GWDcPE1g1d+?gMo)|Xi`5$%_lsCYX-nM9xn|?F`WGOffc$L6!@Roc1>}8m
zwj_Zsr*SR|Rhc~y-ibmgKS#?fCW!T8Z|Jk~`|~?!J6#NQKiHDl9I$=H1mx95D!1Mm
zOYt7j3ksO(Sl^S&`yL$7hP7&gSmCmOZxkjwp}Z3$r$f{07PP?V<8(@V4514eqJ8mA
zJ>*@YEm@DK;@D@K|LJ_7fMu}Fs2ztzWbKglHu&Lvy+M>eHUEyS;hojasS(Yj1+36t
zW>=<2swopMy`La=o`vG3IA*H*AUtaxHTWa>g)^>IGiFB7nmd$Xk9b5&AQA1){*52d
zAps5G5>JQiedzhcXV$%nreaGQ*DnRq0iC*uH*<3MDv^1M_2oIUGMYN#aCXzO66it3
ze{n$2A}$a!dz0CRnCQ?ISHcKyry;Cp;Za)8-Vx3Y`GDqit2f!L8+iv#V+}EMR0241
zPTda}7!?S98nQvlMg}0iM^Hk;uD@6#?*(n`VK1AH`2~p&l8aeF6&v^j8kYkjfqNK-
z*#7zm!>32SyV^ra8?-Fdx5~y$~N?df;OIOM~^^&
zl*_NaRDP=zser`D;LjQq5opn7J-oPokE_hVQbgY$aQk+ykq)WzRm}wnFW?h>auaFY
znK-?7Fuac_It(l+>S(|ch$*%{`q})k76k3$QU<0%US-Z(>1~TVOWMpS<4So;>qBC>
z@2P&gjlBb_Y0}OhtdX#g>mymrX2%RlxgI{1Dblu$(Qu2ITZs2X_sI){QArKfry5
zS?F6QSlu|ZBaKUq7I=lxLp2V7(2reS_6%=@hiDH*Thq$1C3y0*Xsh9y^UVRsKnv*%6SuN1ayU?g_
znn<0R(WB;edZZjZCq35#f@3@RO5Z@hS|<*dol;{vnBe%m<@kO|KOUv#_M9KiQl^=X
zxG&!Xt};=jVOd%QJu_PkJ|Ud|c*H;K$F_$D4L{Ig62?2kE*2)|6x!A`&1}myxwk^K
zKMKk!1S0$EX4k+2*`ER{@B?RZ+qC-q#i5pWjTE}CQ^s;XalLrwhQFCE%%09sU+wa5
zf^uyc34%T(T)g9Ui1TtR@yCdc|NdA7B2p*dKwZZs5QHq}-jrZxva$WOxzfDtzwz
zS_CTd+_c?z9)p!1rA>Gziw-#8_!Lx#$(6rWhq|l3YOP5iJ}n*JwqM+L(!wWqiU}k2
zAEYd*BVY%Hi}b7F&vb{-5Xj2?D0NTcKJS#n6eQf@Mdhay?H|MD7s$M@r`~FqkJFQE*@WL4(+@xQmyCXy!8Q-NeNq5+j
zwJbf&oUhvpbcEMX6RHA&%rcNEn+Y+xw9G>a8!cGOTnekfDq;T6wS&
z8Um4abr$IuZR>mlaZXliFG&66sw9-_@M%y!K>w7Cq0{>9QE8t{a?xvYvwcjLmt6Up
z_tGg(NZN12MA)0R8{9%^q+GsPI`-9k4Tdfi-Zvy|hw7>$wCjzo5X7BJZWFgO3*I$l
zQRe?dA7WhjS`7oq|1xSjYy%!|6oIE25rB)Qs8E|9{Yet~ed3FrfQ0I0LB{7#mxBJ{
z%irz@epP%bl8bW02vqw`FI9rmCT#r6>Fh9OHWnZHjlvgN!=U%-ZtR`&tp>LZTSpxS
ze5DOcv%bzU-EE^wNRg*nI3mTMnOSvC#Ajvsia#$j5^Sm%%6xw%meyf58OpX6|n?_&F@BX-ioD
zT>7DEouFUkn^R1gG)$V<#k{8s)0ggJUDG%kx_jdPC8rhsp`kO*A{++8tc4(6;ih$-
z8fFQCQUL5(>Ee{Uy5%xTu#K>zlCE_jjWQ(S!})tN6%AvXApD_-+&Q?4i(b*a{t?6*
zQ!tD*_^Hvfel51)NL+D(icFKuN=IGE|;
zLJd(Ju-eDi5bw_8BeAqfjRYemhmX1hhgQP{qW)8$^_`Cf9Q#7Y`Te`peb$ENZLB#ygYD+H~$buQ@R^RdjSB~DG
zm)9A({q0f}ksF3#FUS)m#cS+zEr%)xJ$%lES9-`2eDh8HB
zLMK6lq}8|3gV1?Gx|R=nTN_@O7aBLLoM@8VeaQ5SD}=s63JXgZ7mAd=|4?HOH$oj3
zr*qIc4?Howu9a~A$-+l$A}apKoQ&^efR#%pBJk@A>8A@i82_d|!n)^Tq=;oqJ9F^<
zpn%_zh0jyy;quHUs#WnBuWrv4ITmk%nZ*P=!=p^pA&Fk%^*s{q*Ai^c4{bFx90jOLT@II_FcVIfvva|58U;Jn79>Jg2=!&XzW86(NOsS7X}XwYis4OFEJRG)qMGO|pra0;G{j
z=_KW`TD0pX2JwRBc7dt|Vni`MNtQ*p)eOgHj1RlRqr^IoC=I(;x<`xku3J1&D8xSpn59=UO^
zqh4DFGyRZ9Kl3Ik*&&s1ARcdqZoS`?vtLV=O~DB;+~U_Rv7a?w&zzrc*ak3
zxMu_%)D+1l2f4o#obs-isWIYvtZWggi@ch`yyM`i`a~HH*H{#HjV~j`Td|JO)Bp?K
zn)@U?nFHQ3?`K^SRqR+28a8YH6I$y&fe0Sv{~q0K&z{X&o0||I)^&ZYTTC3JFbu|!_sLon1)5!Q
z_PR`Pg*8612pzZvV67kHwAvL`$L^0d&9&AYt_tKTZ*{ijq_@JI_hluBN;!5D+zqE?!xkaO8hP(Cw+<3X1C08!t?E~$rQ
z8oUpdMC6;h&Z+TRD;%Qw!XqJJ!-()c;aSn2uWnyxp_QXUNGOd6X}{^_MNjp;cCrl>
zvf6WDO=4u}NXOYkI(h@9X`bmV!^|fMF)!VcT66~29#xydo04t0_{V}hg;@x;rvf5?
zOL=jO<6KV_`c_zA^W4Uq-_qLb>T=F}Ms1;=E0y3HfcS%CO8U~e@v)y45fB~bQDZT{
z%lXtajGl->+lGPk(|cl#XKFpBNa!3$iX-cF(RQ#J;wsO)v{pm;0(D`zAFzIJ8E_8e
zSHXh}rTRX!vr2u3vI+zqUM@&jAPgF!XeUIR=|XL|&)&^Ky@*n*U2
z$2BPGZW53SZ68M07^sJum=BL4V8?lmL=QYFm#5E46&4@g2*MT$JIi$vG&jhk0oucuDdDxq5iwVc`W2TCvun1P9P>A=!jM9
z{{;d718cq|v_)>DISw}|H)7n3bY=l;Bfh1tItGJ)s4u7EMF>
z4PyXR`ETOC><<6V2kS|Oe7Yox1`*blmSuWp3heO(>oJI!dF&B&#%&zCQ@niW>ZBoD
z_EQ71$MtKkH0V3ag_#LcJM)A^oHpI^1LU7eU|9F-{k=gt`D8vwMF}>IL*((*M&p~|
zbi!TB;^Tw#d}CLr5&QVUTc9wYEynf<@j-+OZYl;a+P2>2$SJ%@lSLX~YH#?YKEF{1
zQ2u6MiviSRK&pcLS5}awLOTTs2W-9fKO+D2jEvcKX*)@7&Tn!seIKu25~GzhU-c0R
zD<5+vZ_7{oo+B7AHL$eKky{Bn%iu1Pa)Z!oX7%lP1o62i->~7`7Ix>r-aSv_c+amw
zxJ5F{elyDmtixQGx6I?hz`q{MmoKG2Rv&$UocTUNT@_0n>sLSF<&g4kb0#t^g319QtmP?Xv-gAiZ^02Fc~Ubz=e$y9L8FLVeHQMU9U}8#@Z=@uI$Yuw(-)7-pvc{F_t;s^62n
zw88>lE+&&uS!-mPc??93Zi74JmBg#-vDzTsMmP=>
literal 9119
zcmV;QBVgPLBmfTBrg}MqvMUC+U59enRFZg3pmmcxg)nQ88jnf=`Zup34iff80LMxY
zs@lY{kQ1fZve6wQ^oOu;6&hG8CC!>hdr_1d1$++3AvM3I&@?LWl}P~|G>6e6%RxFT
z-C31YfoyCS94pos!*3Tt$?$u=Vg1-aw@%O;AcOg0{a#DgYo-+d)_3DH0C3;B13P=6
zi@(JI6zZXaE%?)!Shwn%D7c9^F?v}K&GtP(YTDn)WgdZ|n89ooZ*J@Td6xTrLa7kvIg
zKoQ%WuW?7Ub5PH|yNJ7BELXfE>A{L)T8ibruA9Ua(8lqbk4cmu$LwkT8`?t~LJ0=z
z=vBwm;D}Q`jeXMRm_P2-65M@G=Kv#fU47}u*CdM`eDma*YyfQi19G#YV;(YLC%Q3p
ziHx(e6jN&xDOz^c!;jIKTX550u@Fe3$^EOOfa9s8TP*qDCa44N?g1cf3N*@2pnM7E
zYfkXutOa*R>4ObCC568>f-Gd%<*^kF)qLaRD4N;OaXkK&1d2L*y#GnCks@zGGJxKbmH*{nXi0Px6K*q#
zN9ED~2VP(MK*BrZ>-C~WWPBP5g9(3fRzyxjt4UQ}1tn<9E^4&2%SLSVg@)~C$uT<7Ld97bvEs@-P?L*GnR7B%91tB78@6+Y
zj)4!~!5m12#Udp(b{{>FOB^)BC3`)@+^cTD>%t(&Zz_u?3kL`}jVA06@T%dK?n>D`
zn}GOmr}AnQeYwbkonGcb>I!b3AU?WuII5hoL;GNY8aE>()}_VM?30qRA6G=EOTb0?
zVOs#SyDNkE>Sic0mCQNx6}PpYhR?`FJvDVL^le9gW(3~?VKevD!4{FF$%FN-@MH@@
zXSo$ASLJ|N1TwHx+-IRvw#0DG>beB_kj#lXU#MeVGjn|yRBH>g>#YjI{X^yGS
z9ijbX9+(BxbXQ=f_FlX^S~Pk8;_HgM$->b-_IDn2bZei6ln@VmQmO57%&Guw{#U+G
z`Sflfr|g>HY9O<#6|bSEW)U0dI{f$?(!sdS&?r6zPay)cHd$%H86oJSAw;63Q;_c@
z``>;xF$tuq{NX7umXqcT;pXL6Xu4|*Q=96u*$>2yXy`6{wDQ;6b(X0MYc{svZ9nZ
zlMN+yEP8&P>E44M739F;lmWw;WNo0Ol|ZsCxMWCfQst2cdg5PBW-K5Br3Zc^Rt=%|
zm(b!McjHId-q#!a=)}mG;O7`
zF(1{U07q1K_RE-xR%=LjRj?nxs$SXW&Ro&M%J0o7v!7r>s!D+_zgjI4QS?u!k2#{-+|ra%uBC_*)bQh)5Io
z0)3nWal1*Hv+G0%JFVqr|2|?H;N6UKp%0$hi$8CE<4!;|+z$|KsqnM(I@WpLYKq9R
z{paB9tAA!U;#%7Jp>#kl>W40ru^G_aJp9VKUp_lx{uY}M?&Wv)rG%8T%Px(*GFIo6{&6U^g_?I`dxBw5kyv|(fj
zi+|i3Qg19Dz}}W=-r?;*d$b24ya#yN2riET$}c+b(!wAw`S;_amw3}n0k1jUbqpgC
zErmjvnWePqu%X`gnHRQ&fKo!Y(&lUvTujq4*N{Ka=dFMErX4GJ&4#nBVbq9@{Toct$#z!v0j}+hAP4Z*t1>JWAdu
zjP$#GCw?-lJ|qC3V4k0xT5L!*?HSe6r8>s5juyhc)HMg-J$&LgxSTgwbU`&J`M;T<
zW*e8>l|s{p!SYhftB!_A4Ny~)U)W$5`cihnG
z^m^jjOsJTg!8cUfgPPSaKc(jZ6=Pr~DG+cbW1XK!A@tI{!_MH@jGo^BuDED7)*AX#
z_9k0-;@a~Ut;nav!=3nxb~xdumb30NFc_1Jcwkfnfk3utKv)CjK3AL+W*-e;F^^fB
z6t#5LwtmpRPkT0Bb^=1)>UOQWM3aLq)%zy-hzXTNRbn=oW!jUVFnxfSx(0Hw)nH2p
zxxG|xbKyKo>5ibzvgim?T_^3-(}p&l`rMZlB2kB(2xD$8`l>h|_1c$HzGTqE
zSFhZSm(c~wrHeG3iPz6Z$b#^lWLqQTHCYq|f`XB{9XU1_2B=xqzi=!}&HDM4)KH8T
zcM=0OceB%*P>L=yct8ZBGnK?}B3}MU+36(Ft7^YI)1EnZUOki9dyLO@GI|OcWof%`
z^<175NV-}oB-2h}ce;20(@89!zit{nN-w^85o-;Pmk3b3}=7K|zwh?-L$oWMC4S*AU
zp{fIRr(>4F7{WH_Gkel=gaM0IG_}9!B13V}ZMCZ_e`rDwxaS@uGMp>FCvqYpAlL_A0qC-j|V#JGiusvUiNC
z7S(AJ!@bl!(&