Repository navigation
docs(storagecontrol): add Rapid Cache samples - #16611
Open
sahusneha2004 wants to merge 8 commits into
Open
sahusneha2004 wants to merge 8 commits into
sahusneha2004 wants to merge 8 commits into
Conversation
Adds samples for the Storage Control Rapid Cache CRUD APIs: storage_control_create_rapid_cache, storage_control_get_rapid_cache, storage_control_list_rapid_caches, storage_control_update_rapid_cache, storage_control_disable_rapid_cache. Refs b/482946642 [Generated-by: AI]
product-auto-label
Bot
added
the
samples
sahusneha2004
temporarily deployed
to
internal
November 2, 2026 10:16 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
sahusneha2004
added
ai-generated
storage-sample-architect
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces code samples for managing Rapid Cache resources in the Google Cloud Storage Control service, including creation, retrieval, listing, updating, and disabling of caches. It also excludes these samples from the integration tests against production due to the long duration required to disable a Rapid Cache. The code review feedback requests replacing several instances of auto type deduction with explicit StatusOr types to comply with the repository's style guide regarding obscured domain and return types.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #16611 +/- ##
==========================================
- Coverage 92.53% 92.52% -0.01%
==========================================
Files 2269 2269
Lines 222896 222896
==========================================
- Hits 206250 206239 -11
- Misses 16646 16657 +11 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…ation test Set the explicit cache name (ID = zone), cache_type rapid-cache-ultra and ttl 24h on create; wait for the disable LRO; the auto-run asserts running state, cache type, list membership and the updated ttl, and bounds the disable wait. Aligns with googleapis/google-cloud-java#14529. b/482946642 [Generated-by: AI]
sahusneha2004
temporarily deployed
to
internal
November 2, 2026 18:19 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Replace auto with explicit StatusOr<RapidCache>, std::optional, bool and std::string types, as required by the repository style guide. [Generated-by: AI]
The create sample now only sets the name, zone and cache type, like the Anywhere Cache create sample. The TTL is set by the update sample. The create sample names the ID cache_id, like get and update. The auto-run always disables the cache it created (linear flow, no nested try/catch), bounds the disable wait with the native polling policy instead of a sleep loop, and only accepts a DEADLINE_EXCEEDED timeout. The disable sample comment explains that the operation completes only once the cache is removed. b/482946642 [Generated-by: AI]
Bind cache_id by const reference to zone_name in CreateRapidCache() to satisfy clang-tidy performance-unnecessary-copy-initialization. [Generated-by: AI]
sahusneha2004
marked this pull request as ready for review
November 6, 2026 11:19
kalragauri
reviewed
Nov 9, 2026
kalragauri
left a comment
kalragauri
left a comment
Contributor
There was a problem hiding this comment.
The PR description has drifted from the code: the teardown polling policy is 2 minutes (not 10), there is no NoAwaitTag cleanup path anymore, and the create sample no longer sets ttl = 86400s. Could you rewrite the description to describe only the final state?
…sample Start DisableRapidCache with NoAwaitTag and print the operation name. The cache moves to the disabled state in seconds, but the operation only completes once the cache is fully removed, which can take over an hour. AutoRun now polls GetRapidCache for the disabled state instead. Require GOOGLE_CLOUD_CPP_STORAGE_TEST_RAPID_CACHE_BUCKET_NAME via CheckEnvironmentVariablesAreSet() instead of silently skipping, and soften the wording about the cache ID matching the zone. [Generated-by: AI]
This branch was previously deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds C++ samples for the Storage Control Rapid Cache CRUD APIs in
google/cloud/storagecontrol/v2/samples/storage_control_rapid_cache_samples.cc:storage_control_create_rapid_cache: callsCreateRapidCacheand waits for the LRO. It sets the cachenametoprojects/_/buckets/{bucket}/rapidCaches/{zone}, pluszoneandcache_type = "rapid-cache-ultra". It does not set a TTL, so the service default applies. It prints the name and state.storage_control_get_rapid_cache: prints the name, zone,cache_type, and state.storage_control_list_rapid_cachesstorage_control_update_rapid_cache: updatesttlto 172800s with aFieldMaskand waits for the LRO.storage_control_disable_rapid_cache: starts the LRO withNoAwaitTagand prints the operation name. It does not wait. The cache moves to thedisabledstate within seconds, but the operation only completes once the cache is fully removed, which can take over an hour.Refs b/482946642
Notes
Cache ID:
CreateRapidCacheRequesthas no ID field. In current testing, the service uses the zone name as the cache ID, so the sample sets the name that way. This matches the Java integration test (test(storage): Add integration tests for Storage Control RapidCache CRUD APIs google-cloud-java#14529). The proto does not document it as a contract.Required env var
GOOGLE_CLOUD_CPP_STORAGE_TEST_RAPID_CACHE_BUCKET_NAME: Rapid Cache Ultra needs a regional bucket with hierarchical namespace and UBLA, in the same region as the cache zone. The shared test buckets don't qualify.AutoRunchecks for the variable withexamples::CheckEnvironmentVariablesAreSet()and fails if it is missing, the same as the folder and Anywhere Cache samples. Zone:GOOGLE_CLOUD_CPP_STORAGE_TEST_RAPID_CACHE_ZONE, thenGOOGLE_CLOUD_CPP_TEST_ZONE, thenus-central1-a.AutoRun checks:
state == "running"andcache_typeListRapidCachesttl == 172800sGetRapidCachefor about 2 minutes untilstate == "disabled"If an earlier step fails, AutoRun still runs the disable step and then rethrows the first error.
Excluded from
integration-production.sh, like the Anywhere Cache samples. A disabled Rapid Cache can take over an hour to be fully removed. That blocks back-to-back runs in the same zone and blocks deleting the bucket (HTTP 409 "has Rapid Cache Ultra").Validation
clang-formatapplied;bazel buildOK. The local fast checkers can't run here because thetypostool is missing, so this relies on the CI checkers.storage-prober-prelaunch-acv2, with a new regional HNS+UBLA bucket inus-central1(zoneus-central1-a). Create → get → list → update (TTL 172800s) → disable (NoAwaitTag) → statedisabled: PASSED.