Skip to content

Conversation

@mahendra-google
Copy link
Contributor

@mahendra-google mahendra-google commented Dec 9, 2025

This PR adds a new code sample and test for the ListBuckets operation using the ReturnPartialSuccess parameter in ListBucketOptions.

The ReturnPartialSuccess flag allows the API to return a list of buckets even if specific regions are temporarily unavailable, rather than failing the entire request. This sample demonstrates how to consume the resulting Reachable and Unreachable collections. Please see b/459649174. Note: - PR will be marked as ready to review once Google.Cloud.Storage.V1 new package is released.

@mahendra-google mahendra-google requested review from a team as code owners December 9, 2025 07:19
@snippet-bot
Copy link

snippet-bot bot commented Dec 9, 2025

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added api: storage Issues related to the Cloud Storage API. samples Issues that are directly related to samples. labels Dec 9, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @mahendra-google, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new C# code sample and an accompanying test for the Google Cloud Storage client library. The sample demonstrates how to effectively use the ListBuckets operation with the ReturnPartialSuccess parameter, enabling the API to return available bucket information even when certain regions are temporarily inaccessible. This feature significantly improves the resilience of bucket listing by providing partial results rather than a complete failure, and the sample illustrates how to process both reachable and unreachable bucket collections.

Highlights

  • New Sample Added: Introduced a new C# sample for the ListBuckets operation utilizing the ReturnPartialSuccess option.
  • New Test Case: Implemented a corresponding XUnit test to validate the functionality of the new ListBucketsWithPartialSuccess sample.
  • Dependency Update: Updated the Google.Cloud.Storage.V1 NuGet package to version 4.14.0.
  • Test Fixture Enhancement: Enhanced the StorageFixture.CreateBucket method to allow specifying a storageClass for bucket creation, supporting test scenarios.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new code sample and corresponding test for listing buckets with partial success enabled. The changes are well-implemented, and the test correctly verifies the functionality while avoiding flakiness. I have one suggestion to improve the clarity and robustness of the new sample code by removing an optional parameter that could lead to unhandled exceptions.

Comment on lines +33 to +40
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
});

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The method is named ListBucketsWithPartialSuccess, which strongly implies that the ReturnPartialSuccess option is always enabled. Exposing a returnPartialSuccess parameter to disable this feature can be confusing for users of this sample.

Furthermore, if this method is called with returnPartialSuccess: false and some storage locations are unreachable, the storage.ListBuckets call 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 returnPartialSuccess parameter and hardcoding the option to true.

Please also remove the corresponding <param name="returnPartialSuccess"> documentation block from lines 30-32.

    public (IReadOnlyList<Bucket> Reachable, IReadOnlyList<string> Unreachable) ListBucketsWithPartialSuccess
        (string projectId = "your-project-id")
    {
        var storage = StorageClient.Create();
        var pagedResult = storage.ListBuckets(projectId, options: new ListBucketsOptions
        {
            ReturnPartialSuccess = true
        });

@mahendra-google
Copy link
Contributor Author

mahendra-google commented Dec 9, 2025

Converting this PR into draft mode as the latest Nuget package for Google.Cloud.Storage.V1 is not released yet (containing the ReturnPartialSuccess boolean flag in ListBucketOptions ). I will make this PR ready to review once the package is released.

@mahendra-google mahendra-google marked this pull request as draft December 9, 2025 09:08
@mahendra-google mahendra-google force-pushed the list-bucket-partials-support branch from ef03f67 to 7c0bb19 Compare December 9, 2025 11:20
@amanda-tarafa amanda-tarafa removed their assignment Dec 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: storage Issues related to the Cloud Storage API. samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants