Skip to content

Commit 337644a

Browse files
authored
Feat(storage): add partial success bucket list (#2180)
- Add `list_buckets_partial_success` snippet - Handle `unreachable()` metadata in the sample - Add system test to verify snippet execution
1 parent 7b76121 commit 337644a

2 files changed

Lines changed: 62 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?php
2+
/**
3+
* Copyright 2026 Google Inc.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
/**
19+
* For instructions on how to run the full sample:
20+
*
21+
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md
22+
*/
23+
24+
namespace Google\Cloud\Samples\Storage;
25+
26+
# [START storage_list_buckets_partial_success]
27+
use Google\Cloud\Storage\StorageClient;
28+
29+
/**
30+
* Retrieves a list of buckets while gracefully handling regional downtime.
31+
*/
32+
function list_buckets_partial_success(): void
33+
{
34+
$storage = new StorageClient();
35+
$options = [ 'returnPartialSuccess' => true ];
36+
$buckets = $storage->buckets($options);
37+
38+
// Check for unreachable locations first
39+
// Note: unreachable() returns an array of strings for buckets in unavailable regions
40+
if ($unreachable = $buckets->unreachable()) {
41+
foreach ($unreachable as $location) {
42+
printf('Unreachable Bucket: %s' . PHP_EOL, $location);
43+
}
44+
}
45+
46+
// Iterate through the buckets that were successfully retrieved
47+
foreach ($buckets as $bucket) {
48+
printf('Bucket: %s' . PHP_EOL, $bucket->name());
49+
}
50+
}
51+
# [END storage_list_buckets_partial_success]
52+
53+
// The following 2 lines are only needed to run the samples
54+
require_once __DIR__ . '/../../testing/sample_helpers.php';
55+
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/test/storageTest.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,13 @@ public function testListBuckets()
147147
$this->assertStringContainsString('Bucket:', $output);
148148
}
149149

150+
public function testListBucketsPartialSuccess()
151+
{
152+
$output = $this->runFunctionSnippet('list_buckets_partial_success');
153+
$this->assertStringContainsString('Bucket:', $output);
154+
$this->assertTrue(true);
155+
}
156+
150157
public function testListSoftDeletedBuckets()
151158
{
152159
$output = $this->runFunctionSnippet('list_soft_deleted_buckets');

0 commit comments

Comments
 (0)