feat(storage): sample for autoclass (GoogleCloudPlatform#1685)

Author: vishwarajanand

storage/src/get_bucket_autoclass.php

@@ -0,0 +1,56 @@
+
+/**
+ * Copyright 2022 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
+ *
+ *     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.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_get_autoclass]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Print a bucket autoclass configuration.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket (e.g. 'my-bucket').
+ */
+function get_bucket_autoclass(string $bucketName): void
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+
+    $info = $bucket->info();
+
+    if (isset($info['autoclass'])) {
+        printf('Bucket %s has autoclass enabled: %s' . PHP_EOL,
+            $bucketName,
+            $info['autoclass']['enabled']
+        );
+        printf('Bucket %s has autoclass toggle time: %s' . PHP_EOL,
+            $bucketName,
+            $info['autoclass']['toggleTime']
+        );
+    }
+}
+# [END storage_get_autoclass]
+
+// 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);

storage/src/set_bucket_autoclass.php

@@ -0,0 +1,59 @@
+
+/**
+ * Copyright 2022 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
+ *
+ *     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.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_set_autoclass]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Updates an existing bucket with provided autoclass toggle.
+ *
+ * Note: Only patch requests that disable autoclass are currently supported.
+ * To enable autoclass, it must be set at bucket creation time.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket (e.g. 'my-bucket').
+ * @param bool $autoclassStatus If true, enables Autoclass. Disables otherwise.
+ */
+function set_bucket_autoclass(string $bucketName, bool $autoclassStatus): void
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+
+    $bucket->update([
+        'autoclass' => [
+            'enabled' => $autoclassStatus,
+        ],
+    ]);
+
+    printf(
+        'Updated bucket %s with autoclass set to %s.' . PHP_EOL,
+        $bucketName,
+        $autoclassStatus ? 'true' : 'false'
+    );
+}
+# [END storage_set_autoclass]
+
+// 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);

storage/test/storageTest.php

@@ -792,6 +792,54 @@ public function testChangeDefaultStorageClass()
         );
     }
 
+    public function testGetBucketWithAutoclass()
+    {
+        $bucketName = uniqid('samples-get-autoclass-');
+        $bucket = self::$storage->createBucket($bucketName, [
+            'autoclass' => [
+                'enabled' => true,
+            ],
+            'location' => 'US',
+        ]);
+
+        $output = self::runFunctionSnippet('get_bucket_autoclass', [
+            $bucketName,
+        ]);
+        $bucket->delete();
+
+        $this->assertStringContainsString(
+            sprintf('Bucket %s has autoclass enabled: %s', $bucketName, true),
+            $output
+        );
+    }
+
+    public function testSetBucketWithAutoclass()
+    {
+        $bucket = self::$storage->createBucket(uniqid('samples-set-autoclass-'), [
+            'autoclass' => [
+                'enabled' => true,
+            ],
+            'location' => 'US',
+        ]);
+        $info = $bucket->reload();
+        $this->assertArrayHasKey('autoclass', $info);
+        $this->assertTrue($info['autoclass']['enabled']);
+
+        $output = self::runFunctionSnippet('set_bucket_autoclass', [
+            $bucket->name(),
+            false
+        ]);
+        $bucket->delete();
+
+        $this->assertStringContainsString(
+            sprintf(
+                'Updated bucket %s with autoclass set to false.',
+                $bucket->name(),
+            ),
+            $output
+        );
+    }
+
     public function testDeleteFileArchivedGeneration()
     {
         $bucket = self::$storage->createBucket(uniqid('samples-delete-file-archived-generation-'), [