feat(StorageInsights): Adding samples (#1988)

Author: vishwarajanand

storageinsights/README.md

@@ -0,0 +1,61 @@
+# Google Cloud Storage Insights Samples
+
+## Description
+
+All code in the snippets directory demonstrate how to invoke
+[Cloud Storage Insights][cloud-storage-insights] from PHP.
+
+[cloud-storage-insights]: https://cloud.google.com/storage/docs/insights/inventory-reports
+
+## Setup:
+
+1.  **Enable APIs** - [Enable the Storage Insights Service API](https://console.cloud.google.com/flows/enableapi?apiid=storageinsights.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
+
+    ```sh
+    $ git clone https://github.com/GoogleCloudPlatform/php-docs-samples
+    $ cd php-docs-samples/storageinsights
+    ```
+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).
+
+
+## Samples
+
+To run the Storage Insights Samples, run any of the files in `src/` on the CLI:
+
+```
+$ php src/create_inventory_report_config.php
+
+Usage: create_inventory_report_config.php $bucketName $sourceGcsBucketName $sinkGcsBucketName
+
+  @param string $projectId The Project ID
+  @param string $location The location of bucket
+  @param string $sourceBucketName The Storage bucket name
+  @param string $destinationBucketName The Storage bucket name
+```
+
+## The client library
+
+This sample uses the [Cloud Storage Insights Client Library for PHP][google-cloud-php-storage-insights].
+You can read the documentation for more details on API usage and use GitHub
+to [browse the source][google-cloud-php-source] and  [report issues][google-cloud-php-issues].
+
+[google-cloud-php-storage-insights]: https://cloud.google.com/storage/docs/insights/inventory-reports
+[google-cloud-php-source]: https://github.com/GoogleCloudPlatform/google-cloud-php
+[google-cloud-php-issues]: https://github.com/GoogleCloudPlatform/google-cloud-php/issues
+[google-cloud-sdk]: https://cloud.google.com/sdk/
+
+## Contributing changes
+
+* See [CONTRIBUTING.md](../../CONTRIBUTING.md)
+
+## Licensing
+
+* See [LICENSE](../../LICENSE)

storageinsights/composer.json

@@ -0,0 +1,8 @@
+{
+    "require": {
+        "google/cloud-storageinsights": "^0.3.2"
+    },
+    "require-dev": {
+        "google/cloud-storage": "^1.41.0"
+    }
+}

storageinsights/phpunit.xml.dist

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="../testing/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+    <exclude>
+      <directory>./vendor</directory>
+    </exclude>
+    <report>
+      <clover outputFile="build/logs/clover.xml"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="PHP storageinsights test">
+      <directory>test</directory>
+    </testsuite>
+  </testsuites>
+  <logging/>
+  <php>
+    <env name="PHPUNIT_TESTS" value="1"/>
+  </php>
+</phpunit>

storageinsights/src/create_inventory_report_config.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Copyright 2024 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.
+ */
+
+namespace Google\Cloud\Samples\StorageInsights;
+
+# [START storageinsights_create_inventory_report_config]
+use Google\Type\Date;
+use Google\Cloud\StorageInsights\V1\CSVOptions;
+use Google\Cloud\StorageInsights\V1\ReportConfig;
+use Google\Cloud\StorageInsights\V1\FrequencyOptions;
+use Google\Cloud\StorageInsights\V1\CloudStorageFilters;
+use Google\Cloud\StorageInsights\V1\StorageInsightsClient;
+use Google\Cloud\StorageInsights\V1\ObjectMetadataReportOptions;
+use Google\Cloud\StorageInsights\V1\CloudStorageDestinationOptions;
+
+/**
+ * Creates an inventory report config.
+ * Example:
+ * ```
+ * create_inventory_report_config($projectId, $bucketLocation, $sourceBucket, $destinationBucket);
+ * ```
+ * @param string $projectId Your Google Cloud Project ID
+ * @param string $bucketLocation The location of your source and destination buckets
+ * @param string $sourceBucket The name of your Google Cloud Storage source bucket
+ * @param string $destinationBucket The name of your Google Cloud Storage destination bucket
+ */
+function create_inventory_report_config(
+    string $projectId,
+    string $bucketLocation,
+    string $sourceBucket,
+    string $destinationBucket
+): void {
+    $storageInsightsClient = new StorageInsightsClient();
+
+    $reportConfig = (new ReportConfig())
+        ->setDisplayName('Example inventory report configuration')
+        ->setFrequencyOptions((new FrequencyOptions())
+            ->setFrequency(FrequencyOptions\Frequency::WEEKLY)
+            ->setStartDate((new Date())
+                ->setDay(15)
+                ->setMonth(8)
+                ->setYear(3023))
+            ->setEndDate((new Date())
+                ->setDay(15)
+                ->setMonth(9)
+                ->setYear(3023)))
+        ->setCsvOptions((new CSVOptions())
+            ->setDelimiter(',')
+            ->setRecordSeparator("\n")
+            ->setHeaderRequired(true))
+        ->setObjectMetadataReportOptions((new ObjectMetadataReportOptions())
+            ->setMetadataFields(['project', 'name', 'bucket'])
+            ->setStorageFilters((new CloudStorageFilters())
+                ->setBucket($sourceBucket))
+            ->setStorageDestinationOptions((new CloudStorageDestinationOptions())
+                ->setBucket($destinationBucket)));
+
+    $formattedParent = $storageInsightsClient->locationName($projectId, $bucketLocation);
+    $response = $storageInsightsClient->createReportConfig($formattedParent, $reportConfig);
+
+    print('Created inventory report config with name:' . PHP_EOL);
+    print($response->getName());
+}
+# [END storageinsights_create_inventory_report_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);

storageinsights/src/delete_inventory_report_config.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright 2024 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.
+ */
+
+namespace Google\Cloud\Samples\StorageInsights;
+
+# [START storageinsights_delete_inventory_report_config]
+use Google\Cloud\StorageInsights\V1\StorageInsightsClient;
+
+/**
+ * Delete an inventory report config.
+ * Example:
+ * ```
+ * delete_inventory_report_config($projectId, $bucketLocation, $inventoryReportConfigUuid);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud Project ID
+ * @param string $bucketLocation The location of your bucket
+ * @param string $inventoryReportConfigUuid The UUID of the inventory report config you want to delete
+ */
+function delete_inventory_report_config(
+    string $projectId,
+    string $bucketLocation,
+    string $inventoryReportConfigUuid
+): void {
+    $storageInsightsClient = new StorageInsightsClient();
+
+    $reportConfigName = $storageInsightsClient->reportConfigName($projectId, $bucketLocation, $inventoryReportConfigUuid);
+    $storageInsightsClient->deleteReportConfig($reportConfigName);
+
+    printf('Deleted inventory report config with name %s' . PHP_EOL, $reportConfigName);
+}
+# [END storageinsights_delete_inventory_report_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);

storageinsights/src/edit_inventory_report_config.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Copyright 2024 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.
+ */
+
+namespace Google\Cloud\Samples\StorageInsights;
+
+# [START storageinsights_edit_inventory_report_config]
+use Google\Cloud\StorageInsights\V1\StorageInsightsClient;
+use Google\Protobuf\FieldMask;
+
+/**
+ * Update an existing inventory report config.
+ * Example:
+ * ```
+ * edit_inventory_report_config($projectId, $bucketLocation, $inventoryReportConfigUuid);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud Project ID
+ * @param string $bucketLocation The location of your bucket
+ * @param string $inventoryReportConfigUuid The UUID of the inventory report config to edit
+ */
+function edit_inventory_report_config(
+    string $projectId,
+    string $bucketLocation,
+    string $inventoryReportConfigUuid
+): void {
+    $storageInsightsClient = new StorageInsightsClient();
+
+    $reportConfigName = $storageInsightsClient->reportConfigName($projectId, $bucketLocation, $inventoryReportConfigUuid);
+    $reportConfig = $storageInsightsClient->getReportConfig($reportConfigName);
+
+    // Set any other fields you want to update here
+    $updatedReportConfig = $reportConfig->setDisplayName('Updated Display Name');
+    $updateMask = new FieldMask([
+        'paths' => ['display_name']
+    ]);
+
+    $storageInsightsClient->updateReportConfig($updateMask, $updatedReportConfig);
+
+    printf('Edited inventory report config with name %s' . PHP_EOL, $reportConfigName);
+}
+# [END storageinsights_edit_inventory_report_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);

storageinsights/src/get_inventory_report_names.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright 2024 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.
+ */
+
+namespace Google\Cloud\Samples\StorageInsights;
+
+# [START storageinsights_get_inventory_report_names]
+use Google\Cloud\StorageInsights\V1\StorageInsightsClient;
+
+/**
+ * Gets an existing inventory report config.
+ * Example:
+ * ```
+ * get_inventory_report_names($projectId, $bucketLocation, $inventoryReportConfigUuid);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud Project ID
+ * @param string $bucketLocation The location your bucket is in
+ * @param string $inventoryReportConfigUuid The UUID of the inventory report you want to get file names for
+ */
+function get_inventory_report_names(
+    string $projectId,
+    string $bucketLocation,
+    string $inventoryReportConfigUuid
+): void {
+    $storageInsightsClient = new StorageInsightsClient();
+
+    $reportConfigName = $storageInsightsClient->reportConfigName($projectId, $bucketLocation, $inventoryReportConfigUuid);
+    $reportConfig = $storageInsightsClient->getReportConfig($reportConfigName);
+    $extension = $reportConfig->hasCsvOptions() ? 'csv' : 'parquet';
+    print('You can use the Google Cloud Storage Client '
+        . 'to download the following objects from Google Cloud Storage:' . PHP_EOL);
+    $listReportConfigs = $storageInsightsClient->listReportDetails($reportConfig->getName());
+    foreach ($listReportConfigs->iterateAllElements() as $reportDetail) {
+        for ($index = $reportDetail->getShardsCount() - 1; $index >= 0; $index--) {
+            printf('%s%d.%s' . PHP_EOL, $reportDetail->getReportPathPrefix(), $index, $extension);
+        }
+    }
+}
+# [END storageinsights_get_inventory_report_names]
+
+// 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);

storageinsights/src/list_inventory_report_configs.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright 2024 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.
+ */
+
+namespace Google\Cloud\Samples\StorageInsights;
+
+# [START storageinsights_list_inventory_report_configs]
+use Google\Cloud\StorageInsights\V1\StorageInsightsClient;
+
+/**
+ * Lists inventory report configs.
+ * Example:
+ * ```
+ * list_inventory_report_configs($projectId, $location);
+ * ```
+ *
+ * @param string $projectId Your Google Cloud Project ID
+ * @param string $location The location to list configs in
+ */
+function list_inventory_report_configs(string $projectId, string $location): void
+{
+    $storageInsightsClient = new StorageInsightsClient();
+
+    $formattedParent = $storageInsightsClient->locationName($projectId, $location);
+    $configs = $storageInsightsClient->listReportConfigs($formattedParent);
+
+    printf('Inventory report configs in project %s and location %s:' . PHP_EOL, $projectId, $location);
+    foreach ($configs->iterateAllElements() as $config) {
+        printf('%s' . PHP_EOL, $config->getName());
+    }
+}
+# [END storageinsights_list_inventory_report_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);