samples(StorageControl): Add sample for anywhereCache

storagecontrol/README.md

@@ -58,3 +58,7 @@ to [browse the source][google-cloud-php-source] and  [report issues][google-clou
 ## Licensing
 
 * See [LICENSE](../../LICENSE)
+
+## Note
+
+Tests for Anywhere cache Sample are not included due to the long operation times typical for cache operations.

storagecontrol/composer.json

@@ -3,6 +3,6 @@
         "google/cloud-storage-control": "1.3.0"
     },
     "require-dev": {
-        "google/cloud-storage": "^1.41.3"
+        "google/cloud-storage": "^1.48.1"
     }
 }

storagecontrol/src/create_anywhere_cache.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_create_anywhere_cache]
+use Google\Cloud\Storage\Control\V2\AnywhereCache;
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\CreateAnywhereCacheRequest;
+
+/**
+ * Creates an Anywhere Cache instance.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $zone The zone in which the cache instance is running.
+ *        (e.g. 'us-east1-b')
+ */
+function create_anywhere_cache(string $bucketName, string $zone): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->bucketName('_', $bucketName);
+
+    $anywhereCache = new AnywhereCache([
+        'zone' => $zone,
+    ]);
+
+    $request = new CreateAnywhereCacheRequest([
+        'parent' => $formattedName,
+        'anywhere_cache' => $anywhereCache,
+    ]);
+
+    // Start a create operation and block until it completes. Real applications
+    // may want to setup a callback, wait on a coroutine, or poll until it
+    // completes.
+    $response = $storageControlClient->createAnywhereCache($request);
+
+    printf('Created anywhere cache: %s', $response->getName());
+}
+# [END storage_control_create_anywhere_cache]
+
+// 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);

storagecontrol/src/disable_anywhere_cache.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_disable_anywhere_cache]
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\DisableAnywhereCacheRequest;
+
+/**
+ * Disables an Anywhere Cache instance.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $anywhereCacheId Uniquely identifies the cache.
+ *       (e.g. 'us-east1-b')
+ */
+function disable_anywhere_cache(string $bucketName, string $anywhereCacheId): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->anywhereCacheName('_', $bucketName, $anywhereCacheId);
+
+    $request = new DisableAnywhereCacheRequest([
+        'name' => $formattedName
+    ]);
+
+    $response = $storageControlClient->disableAnywhereCache($request);
+
+    printf('Disabled anywhere cache: %s', $response->getName());
+}
+# [END storage_control_disable_anywhere_cache]
+
+// 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);

storagecontrol/src/get_anywhere_cache.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_get_anywhere_cache]
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\GetAnywhereCacheRequest;
+
+/**
+ * Gets an Anywhere Cache instance.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $anywhereCacheId Uniquely identifies the cache.
+ *        (e.g. 'us-east1-b')
+ */
+function get_anywhere_cache(string $bucketName, string $anywhereCacheId): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->anywhereCacheName('_', $bucketName, $anywhereCacheId);
+
+    $request = new GetAnywhereCacheRequest([
+        'name' => $formattedName,
+    ]);
+
+    $response = $storageControlClient->getAnywhereCache($request);
+
+    printf('Got anywhere cache: %s', $response->getName());
+}
+# [END storage_control_get_anywhere_cache]
+
+// 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);

storagecontrol/src/list_anywhere_caches.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_list_anywhere_caches]
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\ListAnywhereCachesRequest;
+
+/**
+ * Lists Anywhere Cache instances for a given bucket.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ */
+function list_anywhere_caches(string $bucketName): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->bucketName('_', $bucketName);
+
+    $request = new ListAnywhereCachesRequest([
+        'parent' => $formattedName,
+    ]);
+
+    $response = $storageControlClient->listAnywhereCaches($request);
+
+    foreach ($response as $anywhereCache) {
+        printf('Anywhere cache name: %s' . PHP_EOL, $anywhereCache->getName());
+    }
+}
+# [END storage_control_list_anywhere_caches]
+
+// 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);

storagecontrol/src/pause_anywhere_cache.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_pause_anywhere_cache]
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\PauseAnywhereCacheRequest;
+
+/**
+ * Pauses an Anywhere Cache instance.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $anywhereCacheId Uniquely identifies the cache.
+ *        (e.g. 'us-east1-b')
+ */
+function pause_anywhere_cache(string $bucketName, string $anywhereCacheId): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->anywhereCacheName('_', $bucketName, $anywhereCacheId);
+
+    $request = new PauseAnywhereCacheRequest([
+        'name' => $formattedName,
+    ]);
+
+    $response = $storageControlClient->pauseAnywhereCache($request);
+
+    printf('Paused anywhere cache: %s', $response->getName());
+}
+# [END storage_control_pause_anywhere_cache]
+
+// 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);

storagecontrol/src/resume_anywhere_cache.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Copyright 2025 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/main/storagecontrol/README.md
+ */
+
+namespace Google\Cloud\Samples\StorageControl;
+
+# [START storage_control_resume_anywhere_cache]
+use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
+use Google\Cloud\Storage\Control\V2\ResumeAnywhereCacheRequest;
+
+/**
+ * Resumes a disabled or paused Anywhere Cache instance.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $anywhereCacheId Uniquely identifies the cache.
+ *        (e.g. 'us-east1-b')
+ */
+function resume_anywhere_cache(string $bucketName, string $anywhereCacheId): void
+{
+    $storageControlClient = new StorageControlClient();
+
+    // Set project to "_" to signify global bucket
+    $formattedName = $storageControlClient->anywhereCacheName('_', $bucketName, $anywhereCacheId);
+
+    $request = new ResumeAnywhereCacheRequest([
+        'name' => $formattedName
+    ]);
+
+    $response = $storageControlClient->resumeAnywhereCache($request);
+
+    printf('Resumed anywhere cache: %s', $response->getName());
+}
+# [END storage_control_resume_anywhere_cache]
+
+// 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);