-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Samples(Storage): Add sample and test for ListBuckets With Partial Success #3279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
mahendra-google
wants to merge
1
commit into
GoogleCloudPlatform:main
Choose a base branch
from
mahendra-google:list-bucket-partials-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
45 changes: 45 additions & 0 deletions
45
storage/api/Storage.Samples.Tests/ListBucketsWithPartialSuccessTest.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // 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 | ||
| // | ||
| // 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. | ||
|
|
||
| using System.Linq; | ||
| using Xunit; | ||
|
|
||
| [Collection(nameof(StorageFixture))] | ||
| public class ListBucketsWithPartialSuccessTest | ||
| { | ||
| private readonly StorageFixture _fixture; | ||
|
|
||
| public ListBucketsWithPartialSuccessTest(StorageFixture fixture) | ||
| { | ||
| _fixture = fixture; | ||
| } | ||
|
|
||
| [Fact] | ||
| public void ListBucketsWithPartialSuccess() | ||
| { | ||
| ListBucketsWithPartialSuccessSample partialSample = new ListBucketsWithPartialSuccessSample(); | ||
| var bucketName = _fixture.GenerateBucketName(); | ||
| _fixture.CreateBucket(bucketName: bucketName, location: "US", storageClass: "MULTI_REGIONAL"); | ||
|
|
||
| var buckets = partialSample.ListBucketsWithPartialSuccess(_fixture.ProjectId); | ||
|
|
||
| Assert.Contains(buckets.Reachable, c => c.Name == bucketName); | ||
|
|
||
| if (buckets.Unreachable.Any()) | ||
| { | ||
| // This indicates that the environment had unreachable buckets. | ||
| // We don't assert on the count to avoid flaky tests. | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
storage/api/Storage.Samples/ListBucketsWithPartialSuccess.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // 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 | ||
| // | ||
| // 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 storage_list_buckets_partial_success] | ||
|
|
||
| using Google.Api.Gax; | ||
| using Google.Apis.Storage.v1.Data; | ||
| using Google.Cloud.Storage.V1; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
|
|
||
| public class ListBucketsWithPartialSuccessSample | ||
| { | ||
| /// <summary> | ||
| /// Lists buckets with an option of return partial success if specific regions are unreachable. | ||
| /// </summary> | ||
| /// <param name="projectId">The ID of the project to list the buckets.</param> | ||
| /// <param name="returnPartialSuccess">If true, buckets from reachable locations are returned. The resource names of | ||
| /// buckets from unreachable locations will be available on the <c>Unreachable</c> property of a raw response from | ||
| /// <see cref="PagedEnumerable{TResponse, TResource}.AsRawResponses"/>.</param> | ||
| public (IReadOnlyList<Bucket> Reachable, IReadOnlyList<string> Unreachable) ListBucketsWithPartialSuccess | ||
| (string projectId = "your-project-id", bool returnPartialSuccess = true) | ||
| { | ||
| var storage = StorageClient.Create(); | ||
| var pagedResult = storage.ListBuckets(projectId, options: new ListBucketsOptions | ||
| { | ||
| ReturnPartialSuccess = returnPartialSuccess | ||
| }); | ||
|
|
||
| var reachableBuckets = new List<Bucket>(); | ||
| var unreachableBuckets = new List<string>(); | ||
|
|
||
| foreach (var page in pagedResult.AsRawResponses()) | ||
| { | ||
| reachableBuckets.AddRange(page.Items ?? Enumerable.Empty<Bucket>()); | ||
| unreachableBuckets.AddRange(page.Unreachable ?? Enumerable.Empty<string>()); | ||
| } | ||
|
|
||
| Console.WriteLine("Buckets:"); | ||
| foreach (var bucket in reachableBuckets) | ||
| { | ||
| Console.WriteLine(bucket.Name); | ||
| } | ||
|
|
||
| if (unreachableBuckets.Any()) | ||
| { | ||
| Console.WriteLine("The Resource Names of Buckets from Unreachable Locations:"); | ||
| foreach (var bucket in unreachableBuckets) | ||
| { | ||
| Console.WriteLine(bucket); | ||
| } | ||
| } | ||
| return (reachableBuckets, unreachableBuckets); | ||
| } | ||
| } | ||
| // [END storage_list_buckets_partial_success] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The method is named
ListBucketsWithPartialSuccess, which strongly implies that theReturnPartialSuccessoption is always enabled. Exposing areturnPartialSuccessparameter to disable this feature can be confusing for users of this sample.Furthermore, if this method is called with
returnPartialSuccess: falseand some storage locations are unreachable, thestorage.ListBucketscall will throw an exception. Since this sample doesn't include error handling for that scenario, it could lead to an unexpected crash.To make the sample more focused, clear, and robust, I suggest removing the
returnPartialSuccessparameter and hardcoding the option totrue.Please also remove the corresponding
<param name="returnPartialSuccess">documentation block from lines 30-32.