feat: add storage control anywhere cache samples #4177

thiyaguk09 · 2025-09-04T06:39:56Z

Description

Fixes #

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

Note: Any check with (dev), (experimental), or (legacy) can be ignored and should not block your PR from merging (see CI testing).

snippet-bot · 2025-09-04T13:05:43Z

Here is the summary of changes.

You are about to add 7 region tags.

storage-control/createAnywhereCache.js:25, tag storage_control_create_anywhere_cache
storage-control/disableAnywhereCache.js:25, tag storage_control_disable_anywhere_cache
storage-control/getAnywhereCache.js:25, tag storage_control_get_anywhere_cache
storage-control/listAnywhereCaches.js:26, tag storage_control_list_anywhere_caches
storage-control/pauseAnywhereCache.js:25, tag storage_control_pause_anywhere_cache
storage-control/resumeAnywhereCache.js:25, tag storage_control_resume_anywhere_cache
storage-control/updateAnywhereCache.js:25, tag storage_control_update_anywhere_cache

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

iennae · 2025-09-09T02:14:50Z

storage-control/createAnywhereCache.js

+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */


suggestion:

/**

Creates an Anywhere Cache instance for a Cloud Storage bucket.

Anywhere Cache is a feature that provides an SSD-backed zonal read cache.

This can significantly improve read performance for frequently accessed data

by caching it in the same zone as your compute resources.

@param {string} bucketName The name of the bucket to create the cache for.

Example: 'your-gcp-bucket-name'

@param {string} zone The zone where the cache will be created.

Example: 'us-central1-a'
*/

Thank you for your thoughtful suggestion and for providing such a well-crafted JSDoc comment. We aim to maintain a consistent documentation style across all our Cloud Storage samples to offer a unified experience for our users.

Adopting a new format, even if it is an improvement, could impact the overall cohesiveness and clarity of the sample set.

Is there a standard currently being followed that we should adhere to for future reference?

iennae · 2025-09-09T02:17:32Z

storage-control/createAnywhereCache.js

+    const request = {
+      parent: bucketPath,
+      anywhereCache: {
+        zone: zoneName,


should the default sample show a TTL and/or admissionPolicy ? (reading documentation here to better understand) https://cloud.google.com/storage/docs/anywhere-cache

Thank you for the detailed question. You're right that ttlSeconds and admissionPolicy are available fields.

Our sample's goal is to show the simplest, most fundamental usage with only the required parameters. This approach ensures consistency and clarity across all language samples, making it easier for users to get started. While including optional fields would be a good demonstration, we keep the default samples minimal to focus on the core functionality. We appreciate you digging into the documentation!

iennae · 2025-09-09T02:22:25Z

storage-control/disableAnywhereCache.js

+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */


suggestion:

/**

Disables an Anywhere Cache instance.

Disabling a cache is the first step to permanently removing it. Once disabled,

the cache stops ingesting new data. After a grace period, the cache and its

contents are deleted. This is useful for decommissioning caches that are no

longer needed.

@param {string} bucketName The name of the bucket where the cache resides.

Example: 'your-gcp-bucket-name'

@param {string} cacheName The unique identifier of the cache instance to disable.

Example: 'cacheName'
*/

Thank you for your thoughtful suggestion and for providing such a well-crafted JSDoc comment. We aim to maintain a consistent documentation style across all our Cloud Storage samples to offer a unified experience for our users.

Adopting a new format, even if it is an improvement, could impact the overall cohesiveness and clarity of the sample set.

storage-control/disableAnywhereCache.js

iennae · 2025-09-09T02:26:40Z

storage-control/disableAnywhereCache.js

+
+    // Run request
+    const [response] = await controlClient.disableAnywhereCache(request);
+    console.log(`Disabled anywhere cache: ${response.name}.`);


nit: based on if this actually disables or triggers it to be disabled:
wrap everything in a try .. catch and log instead:
console.log(Successfully initiated disablement for Anywhere Cache '${cacheName}'.);
console.log( Current State: ${response.state});

catch potential errors

catch (err) {
console.error(Error disabling Anywhere Cache '${cacheName}': ${err.message});
if (err.code === 5) {
// NOT_FOUND error can occur if the bucket or cache does not exist.
console.error(Please ensure the cache '${cacheName}' exists in bucket '${bucketName}'.);
} else if (err.code === 9) {
// FAILED_PRECONDITION can occur if the cache is already being disabled or is not in a RUNNING state.
console.error(Cache '${cacheName}' may not be in a state that allows disabling.);
}

However, our code samples are designed to demonstrate the simplest, "happy path" usage of a feature. We intentionally omit error handling to keep the code concise and focused on the core API call. This approach ensures all Cloud Storage samples share a consistent, minimal style, making them easier to understand at a glance.

iennae · 2025-09-09T02:27:50Z

storage-control/getAnywhereCache.js

+
+function main(bucketName, cacheName) {
+  // [START storage_control_get_anywhere_cache]
+  /**


nit: suggestion of

/**

Retrieves details of a specific Anywhere Cache instance.

This function is useful for checking the current state, configuration (like TTL),

and other metadata of an existing cache.

@param {string} bucketName The name of the bucket where the cache resides.

Example: 'your-gcp-bucket-name'

@param {string} cacheName The unique identifier of the cache instance.

Example: 'my-anywhere-cache-id'
*/

Thank you for your thoughtful suggestion and for providing such a well-crafted JSDoc comment. We aim to maintain a consistent documentation style across all our Cloud Storage samples to offer a unified experience for our users.

Adopting a new format, even if it is an improvement, could impact the overall cohesiveness and clarity of the sample set.

storage-control/getAnywhereCache.js

iennae · 2025-09-09T02:30:26Z

storage-control/listAnywhereCaches.js

+
+function main(bucketName) {
+  // [START storage_control_list_anywhere_caches]
+  /**


nit: /**

Lists all Anywhere Cache instances for a Cloud Storage bucket.

This function helps you discover all active and pending caches associated with

a specific bucket, which is useful for auditing and management.

@param {string} bucketName The name of the bucket to list caches for.

Example: 'your-gcp-bucket-name'
*/

Thank you for your thoughtful suggestion and for providing such a well-crafted JSDoc comment. We aim to maintain a consistent documentation style across all our Cloud Storage samples to offer a unified experience for our users.

Adopting a new format, even if it is an improvement, could impact the overall cohesiveness and clarity of the sample set.

iennae · 2025-09-09T02:32:11Z

storage-control/listAnywhereCaches.js

+    };
+
+    // Run request
+    const [response] = await controlClient.listAnywhereCaches(request);


might wrap the response in a try.. catch

if there are no Anywhere Caches found for the bucket versus errors listing Anywhere Caches

However, our code samples are designed to demonstrate the simplest, "happy path" usage of a feature. We intentionally omit error handling to keep the code concise and focused on the core API call. This approach ensures all Cloud Storage samples share a consistent, minimal style, making them easier to understand at a glance.

iennae · 2025-09-09T02:35:05Z

storage-control/updateAnywhereCache.js

+
+function main(bucketName, cacheName, admissionPolicy) {
+  // [START storage_control_update_anywhere_cache]
+  /**


nit:

/**

Updates the Admission Policy of an Anywhere Cache instance.

@param {string} bucketName The name of the bucket where the cache resides.

Example: 'your-gcp-bucket-name'

@param {string} cacheName The unique identifier of the cache instance to update.

Example: 'my-anywhere-cache-id'

@param {string} admissionPolicy Determines when data is ingested into the cache
*/

Thank you for your thoughtful suggestion and for providing such a well-crafted JSDoc comment. We aim to maintain a consistent documentation style across all our Cloud Storage samples to offer a unified experience for our users.

Adopting a new format, even if it is an improvement, could impact the overall cohesiveness and clarity of the sample set.

storage-control/updateAnywhereCache.js

iennae

This mostly looks ok. I have a few questions. I did run this through our generation to see what kind of output I received and I've shared those headers for visibility. I think there are a few areas of improvements to make sure there is a try..catch to ensure folks get actionable feedback so they don't assume the code is broken depending on the order in which they run commands.

Thanks!

thiyaguk09 · 2025-09-09T08:32:29Z

This mostly looks ok. I have a few questions. I did run this through our generation to see what kind of output I received and I've shared those headers for visibility. I think there are a few areas of improvements to make sure there is a try..catch to ensure folks get actionable feedback so they don't assume the code is broken depending on the order in which they run commands.

Thanks!

Thank you for the suggestion. Our samples are designed to demonstrate the simplest "happy path" for a feature, focusing on the core API call. We intentionally omit try...catch blocks to keep the code concise and readable, which helps maintain a consistent style across all of our language samples. Furthermore, unhandled rejections are already handled at the application level to prevent the code from breaking, so the primary goal of our samples remains focused on positive-case demonstration.

thiyaguk09 added 5 commits September 3, 2025 07:45

feat(storagecontrol): Add samples for Storage Anywhere Cache

4aa0730

add testcase

e58234d

lint fix

4bbe7b5

fix: test case

2f63e19

fix: remove cacheName

87e3e5f

product-auto-label bot added the samples Issues that are directly related to samples. label Sep 4, 2025

thiyaguk09 added 2 commits September 4, 2025 12:10

Merge branch 'main' into anywhere-cache-samples

0f66b4f

skip test case

6002dac

thiyaguk09 marked this pull request as ready for review September 4, 2025 13:05

thiyaguk09 requested review from a team as code owners September 4, 2025 13:05

test case remove projectId

e1259d1

ddelgrosso1 approved these changes Sep 8, 2025

View reviewed changes

iennae reviewed Sep 9, 2025

View reviewed changes

storage-control/disableAnywhereCache.js Show resolved Hide resolved

iennae reviewed Sep 9, 2025

View reviewed changes

storage-control/getAnywhereCache.js Show resolved Hide resolved

iennae reviewed Sep 9, 2025

View reviewed changes

storage-control/updateAnywhereCache.js Outdated Show resolved Hide resolved

iennae reviewed Sep 9, 2025

View reviewed changes

addressing review comments

e83ba77

thiyaguk09 requested a review from iennae September 9, 2025 09:58

feat: add storage control anywhere cache samples #4177

Are you sure you want to change the base?

feat: add storage control anywhere cache samples #4177

Uh oh!

Conversation

thiyaguk09 commented Sep 4, 2025

Description

Checklist

Uh oh!

snippet-bot bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iennae Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thiyaguk09 Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iennae left a comment

Choose a reason for hiding this comment

Uh oh!

thiyaguk09 commented Sep 9, 2025

Uh oh!

Uh oh!

snippet-bot bot commented Sep 4, 2025 •

edited

Loading

iennae Sep 9, 2025 •

edited

Loading

thiyaguk09 Sep 9, 2025 •

edited

Loading