Storage Control Pause Anywhere Cache

Storage Control Pause Anywhere Cache

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

C++

For more information, see the Cloud Storage C++ API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  namespace 
  
 storagecontrol 
  
 = 
  
 google 
 :: 
 cloud 
 :: 
 storagecontrol_v2 
 ; 
 []( 
 storagecontrol 
 :: 
 StorageControlClient 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 cache_name 
 ) 
  
 { 
  
 auto 
  
 anywhere_cache 
  
 = 
  
 client 
 . 
 PauseAnywhereCache 
 ( 
 cache_name 
 ); 
  
 if 
  
 ( 
 ! 
 anywhere_cache 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 anywhere_cache 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Paused anywhere cache: " 
 << 
 anywhere_cache 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
 } 
 

Java

For more information, see the Cloud Storage Java API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.storage.control.v2. AnywhereCache 
 
 ; 
 import 
  
 com.google.storage.control.v2. PauseAnywhereCacheRequest 
 
 ; 
 import 
  
 com.google.storage.control.v2. StorageControlClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 final 
  
 class 
 AnywhereCachePause 
  
 { 
  
 public 
  
 static 
  
 void 
  
 anywhereCachePause 
 ( 
 String 
  
 cacheName 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 try 
  
 ( 
  StorageControlClient 
 
  
 storageControl 
  
 = 
  
  StorageControlClient 
 
 . 
 create 
 ()) 
  
 { 
  
  PauseAnywhereCacheRequest 
 
  
 request 
  
 = 
  
  PauseAnywhereCacheRequest 
 
 . 
 newBuilder 
 (). 
 setName 
 ( 
 cacheName 
 ). 
 build 
 (); 
  
  AnywhereCache 
 
  
 anywhereCache 
  
 = 
  
 storageControl 
 . 
 pauseAnywhereCache 
 ( 
 request 
 ); 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Paused anywhere cache: %s%n" 
 , 
  
 anywhereCache 
 . 
  getName 
 
 ()); 
  
 } 
  
 } 
 } 
 

PHP

For more information, see the Cloud Storage PHP API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  use Google\Cloud\Storage\Control\V2\Client\StorageControlClient; 
 use Google\Cloud\Storage\Control\V2\PauseAnywhereCacheRequest; 
 /** 
 * Pauses an Anywhere Cache instance. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 * @param string $anywhereCacheId Uniquely identifies the cache. 
 *        (e.g. 'us-east1-b') 
 */ 
 function pause_anywhere_cache(string $bucketName, string $anywhereCacheId): void 
 { 
 $storageControlClient = new StorageControlClient(); 
 // Set project to "_" to signify global bucket 
 $formattedName = $storageControlClient->anywhereCacheName('_', $bucketName, $anywhereCacheId); 
 $request = new PauseAnywhereCacheRequest([ 
 'name' => $formattedName, 
 ]); 
 $response = $storageControlClient->pauseAnywhereCache($request); 
 printf('Paused anywhere cache: %s', $response->getName()); 
 } 
 

Ruby

For more information, see the Cloud Storage Ruby API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  require 
  
 "google/cloud/storage/control" 
 # Pauses a specific Anywhere Cache instance in a Cloud Storage bucket. 
 # This operation does not delete the cache; it can be resumed later using 
 # the `resume_anywhere_cache` method. 
 # 
 # @param bucket_name [String] The name of the Cloud Storage bucket. 
 # @param anywhere_cache_id [String] The ID of the Anywhere Cache instance to pause. 
 #   This is often the zone where the cache is located, e.g., "us-east1-b". 
 # 
 # @example 
 #   pause_anywhere_cache( 
 #     bucket_name: "your-unique-bucket-name", 
 #     anywhere_cache_id: "us-east1-b" 
 #   ) 
 # 
 def 
  
 pause_anywhere_cache 
  
 bucket_name 
 :, 
  
 anywhere_cache_id 
 : 
  
 # Create a client object. The client can be reused for multiple calls. 
  
 storage_control_client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Storage 
 :: 
 Control 
 . 
 storage_control 
  
 # Set project to "_" to signify global bucket 
  
 parent 
  
 = 
  
 "projects/_/buckets/ 
 #{ 
 bucket_name 
 } 
 " 
  
 name 
  
 = 
  
 " 
 #{ 
 parent 
 } 
 /anywhereCaches/ 
 #{ 
 anywhere_cache_id 
 } 
 " 
  
 # Create a request. 
  
 request 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Storage 
 :: 
 Control 
 :: 
 V2 
 :: 
 PauseAnywhereCacheRequest 
 . 
 new 
 ( 
  
 name 
 : 
  
 name 
  
 ) 
  
 # The request pauses the cache, but does not delete it. 
  
 # The cache can be resumed later. 
  
 # The cache is paused in the specified bucket. 
  
 begin 
  
 result 
  
 = 
  
 storage_control_client 
 . 
 pause_anywhere_cache 
  
 request 
  
 puts 
  
 "Successfully 
 #{ 
 result 
 . 
 state 
& . 
 downcase 
 } 
 anywhereCache - 
 #{ 
 result 
 . 
 name 
 } 
 ." 
  
 rescue 
  
 Google 
 :: 
 Cloud 
 :: 
 Error 
  
 = 
>  
 e 
  
 puts 
  
 "Failed to pause AnywhereCache. Error: 
 #{ 
 e 
 . 
 message 
 } 
 " 
  
 end 
 end 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Design a Mobile Site
View Site in Mobile | Classic
Share by: