index on anywhere-cache-samples: e83ba77 addressing review comments

Author: thiyaguk09

storage-control/createAnywhereCache.js

@@ -23,16 +23,19 @@
 
 function main(bucketName, zoneName) {
   // [START storage_control_create_anywhere_cache]
+
   /**
-   * TODO(developer): Uncomment these variables before running the sample.
+   * 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} zoneName The zone where the cache will be created.
+   * Example: 'us-central1-a'
    */
 
-  // The name of your GCS bucket
-  // const bucketName = 'bucketName';
-
-  // The zone that the cache instance will run in.
-  // const zoneName = 'zoneName';
-
   // Imports the Control library
   const {StorageControlClient} = require('@google-cloud/storage-control').v2;
 
@@ -47,6 +50,8 @@ function main(bucketName, zoneName) {
       parent: bucketPath,
       anywhereCache: {
         zone: zoneName,
+        ttl: '70000s',
+        admissionPolicy: 'admit-on-first-miss',
       },
     };
 

storage-control/disableAnywhereCache.js

@@ -24,15 +24,19 @@
 function main(bucketName, cacheName) {
   // [START storage_control_disable_anywhere_cache]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.
+   * 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'
    */
 
-  // The name of your GCS bucket
-  // const bucketName = 'bucketName';
-
-  // The name of the cache to be disabled
-  // const cacheName = 'cacheName';
-
   // Imports the Control library
   const {StorageControlClient} = require('@google-cloud/storage-control').v2;
 

storage-control/getAnywhereCache.js

@@ -24,15 +24,17 @@
 function main(bucketName, cacheName) {
   // [START storage_control_get_anywhere_cache]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.
+   * 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'
    */
 
-  // The name of your GCS bucket
-  // const bucketName = 'bucketName';
-
-  // The name of the cache to get
-  // const cacheName = 'cacheName';
-
   // Imports the Control library
   const {StorageControlClient} = require('@google-cloud/storage-control').v2;
 
@@ -54,6 +56,15 @@ function main(bucketName, cacheName) {
     // Run request
     const [response] = await controlClient.getAnywhereCache(request);
     console.log(`Got anywhere cache: ${response.name}.`);
+    console.log(`Anywhere Cache details for '${cacheName}':`);
+    console.log(`  ID: ${response.id}`);
+    console.log(`  Zone: ${response.zone}`);
+    console.log(`  State: ${response.state}`);
+    console.log(`  TTL: ${response.ttl.seconds}s`);
+    console.log(`  Admission Policy: ${response.admissionPolicy}`);
+    console.log(
+      `  Create Time: ${new Date(response.createTime.seconds * 1000).toISOString()}`
+    );
   }
 
   callGetAnywhereCache();

storage-control/listAnywhereCaches.js

@@ -25,12 +25,14 @@
 function main(bucketName) {
   // [START storage_control_list_anywhere_caches]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.
+   * 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'
    */
 
-  // The name of your GCS bucket
-  // const bucketName = 'bucketName';
-
   // Imports the Control library
   const {StorageControlClient} = require('@google-cloud/storage-control').v2;
 

storage-control/updateAnywhereCache.js

@@ -24,18 +24,16 @@
 function main(bucketName, cacheName, admissionPolicy) {
   // [START storage_control_update_anywhere_cache]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.
+   * 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
+   * Example: 'admit-on-second-miss'
    */
 
-  // The name of your GCS bucket
-  // const bucketName = 'bucketName';
-
-  // The name of the cache to be update
-  // const cacheName = 'cacheName';
-
-  // The admission policy of the cache to be updated
-  // const admissionPolicy = 'admit-on-second-miss';
-
   // Imports the Control library
   const {StorageControlClient} = require('@google-cloud/storage-control').v2;