storage control get a managed folder

Explore further

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

Create and manage managed folders

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 
&  
 bucket_name 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 managed_folder_id 
 ) 
  
 { 
  
 auto 
  
 const 
  
 name 
  
 = 
  
 std 
 :: 
 string 
 { 
 "projects/_/buckets/" 
 } 
  
 + 
  
 bucket_name 
  
 + 
  
 "/managedFolders/" 
  
 + 
  
 managed_folder_id 
 ; 
  
 auto 
  
 managed_folder 
  
 = 
  
 client 
 . 
 GetManagedFolder 
 ( 
 name 
 ); 
  
 if 
  
 ( 
 ! 
 managed_folder 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 managed_folder 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Got managed folder: " 
 << 
 managed_folder 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
 }

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 .

  using 
  
  Google.Cloud.Storage.Control.V2 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 StorageControlGetManagedFolderSample 
 { 
  
 public 
  
 ManagedFolder 
  
 StorageControlGetManagedFolder 
 ( 
 string 
  
 bucketId 
  
 = 
  
 "your-unique-bucket-name" 
 , 
  
 string 
  
 managedFolderId 
  
 = 
  
 "your_managed_folder_Id" 
 ) 
  
 { 
  
  StorageControlClient 
 
  
 storageControl 
  
 = 
  
  StorageControlClient 
 
 . 
  Create 
 
 (); 
  
  ManagedFolderName 
 
  
 managedFolderResourceName 
  
 = 
  
 // Set project to "_" to signify globally scoped bucket 
  
 new 
  
  ManagedFolderName 
 
 ( 
 "_" 
 , 
  
 bucketId 
 , 
  
 managedFolderId 
 ); 
  
  ManagedFolder 
 
  
 managedFolder 
  
 = 
  
 storageControl 
 . 
  GetManagedFolder 
 
 ( 
 managedFolderResourceName 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Got managed folder: {managedFolder. Name 
}" 
 ); 
  
 return 
  
 managedFolder 
 ; 
  
 } 
 }

Go

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

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

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 control 
  
 "cloud.google.com/go/storage/control/apiv2" 
  
 "cloud.google.com/go/storage/control/apiv2/controlpb" 
 ) 
 // getManagedFolder gets metadata for the managed folder with the given name. 
 func 
  
 getManagedFolder 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 bucket 
 , 
  
 folder 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucket := "bucket-name" 
  
 // folder := "managed-folder-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 control 
 . 
 NewStorageControlClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewStorageControlClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
  Close 
 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 30 
 ) 
  
 defer 
  
 cancel 
 () 
  
 // Construct folder path including the bucket name. 
  
 folderPath 
  
 := 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/_/buckets/%v/managedFolders/%v/" 
 , 
  
 bucket 
 , 
  
 folder 
 ) 
  
 req 
  
 := 
  
& controlpb 
 . 
 GetManagedFolderRequest 
 { 
  
 Name 
 : 
  
 folderPath 
 , 
  
 } 
  
 f 
 , 
  
 err 
  
 := 
  
 client 
 . 
 GetManagedFolder 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "GetManagedFolder(%q): %w" 
 , 
  
 folderPath 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "got managed folder metadata: %+v" 
 , 
  
 f 
 ) 
  
 return 
  
 nil 
 }

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. BucketName 
 
 ; 
 import 
  
 com.google.storage.control.v2. GetManagedFolderRequest 
 
 ; 
 import 
  
 com.google.storage.control.v2. ManagedFolder 
 
 ; 
 import 
  
 com.google.storage.control.v2. ManagedFolderName 
 
 ; 
 import 
  
 com.google.storage.control.v2. StorageControlClient 
 
 ; 
 class 
 GetManagedFolder 
  
 { 
  
 public 
  
 static 
  
 void 
  
 managedFolderGet 
 ( 
 String 
  
 bucketName 
 , 
  
 String 
  
 managedFolderId 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // Instantiates a client in a try-with-resource to automatically cleanup underlying resources 
  
 try 
  
 ( 
  StorageControlClient 
 
  
 storageControlClient 
  
 = 
  
  StorageControlClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // Set project to "_" to signify global bucket 
  
  BucketName 
 
  
 resourceBucketName 
  
 = 
  
  BucketName 
 
 . 
 of 
 ( 
 "_" 
 , 
  
 bucketName 
 ); 
  
  GetManagedFolderRequest 
 
  
 getManagedFolderRequest 
  
 = 
  
  GetManagedFolderRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
  
  ManagedFolderName 
 
 . 
 format 
 ( 
  
 resourceBucketName 
 . 
  getProject 
 
 (), 
  
 resourceBucketName 
 . 
  getBucket 
 
 (), 
  
 managedFolderId 
 )) 
  
 . 
 build 
 (); 
  
  ManagedFolder 
 
  
 managedFolder 
  
 = 
  
 storageControlClient 
 . 
 getManagedFolder 
 ( 
 getManagedFolderRequest 
 ); 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Got Managed Folder %s%n" 
 , 
  
 managedFolder 
 . 
  getName 
 
 ()); 
  
 } 
  
 } 
 }

Node.js

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

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

  /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
 // The name of your GCS bucket 
 // const bucketName = 'bucketName'; 
 // The name of the managed folder to get 
 // const managedFolderName = 'managedFolderName'; 
 // Imports the Control library 
 const 
  
 { 
 StorageControlClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage-control 
' 
 ). 
 v2 
 ; 
 // Instantiates a client 
 const 
  
 controlClient 
  
 = 
  
 new 
  
  StorageControlClient 
 
 (); 
 async 
  
 function 
  
 callGetManagedFolder 
 () 
  
 { 
  
 const 
  
 managedFolderPath 
  
 = 
  
 controlClient 
 . 
  managedFolderPath 
 
 ( 
  
 '_' 
 , 
  
 bucketName 
 , 
  
 managedFolderName 
  
 ); 
  
 // Create the request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 : 
  
 managedFolderPath 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 controlClient 
 . 
 getManagedFolder 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 `Got managed folder: 
 ${ 
 response 
 . 
 name 
 } 
 .` 
 ); 
 } 
 callGetManagedFolder 
 ();

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\GetManagedFolderRequest; 
 /** 
 * Get a folder in an existing bucket. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 * @param string $managedFolderId The name of your folder inside the bucket. 
 *        (e.g. 'my-folder') 
 */ 
 function managed_folder_get(string $bucketName, string $managedFolderId): void 
 { 
 $storageControlClient = new StorageControlClient(); 
 // Set project to "_" to signify global bucket 
 $formattedName = $storageControlClient->managedFolderName('_', $bucketName, $managedFolderId); 
 $request = new GetManagedFolderRequest([ 
 'name' => $formattedName, 
 ]); 
 $managedFolder = $storageControlClient->getManagedFolder($request); 
 printf('Got Managed Folder %s', $managedFolder->getName()); 
 }

Python

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

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

  from 
  
 google.cloud 
  
 import 
  storage_control_v2 
 
 def 
  
 get_managed_folder 
 ( 
 bucket_name 
 : 
 str 
 , 
 managed_folder_id 
 : 
 str 
 ) 
 - 
> None 
 : 
 # The ID of your GCS bucket 
 # bucket_name = "your-unique-bucket-name" 
 # The name of the managed folder 
 # managed_folder_id = "managed-folder-name" 
 storage_control_client 
 = 
  storage_control_v2 
 
 . 
  StorageControlClient 
 
 () 
 # The storage bucket path uses the global access pattern, in which the "_" 
 # denotes this bucket exists in the global namespace. 
 folder_path 
 = 
 storage_control_client 
 . 
  managed_folder_path 
 
 ( 
 "_" 
 , 
 bucket_name 
 , 
 managed_folder_id 
 ) 
 request 
 = 
  storage_control_v2 
 
 . 
  GetManagedFolderRequest 
 
 ( 
 name 
 = 
 folder_path 
 , 
 ) 
 response 
 = 
 storage_control_client 
 . 
  get_managed_folder 
 
 ( 
 request 
 = 
 request 
 ) 
 print 
 ( 
 f 
 "Got managed folder: 
 { 
 response 
 . 
 name 
 } 
 " 
 )

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 .

  def 
  
 get_managed_folder 
  
 bucket_name 
 :, 
  
 managed_folder_id 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 # The name of the managed folder to be created 
  
 # managed_folder_id = "managed-folder-name" 
  
 require 
  
 "google/cloud/storage/control" 
  
 storage_control 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Storage 
 :: 
 Control 
 . 
 storage_control 
  
 # The storage bucket path uses the global access pattern, in which the "_" 
  
 # denotes this bucket exists in the global namespace. 
  
 folder_path 
  
 = 
  
 storage_control 
 . 
 managed_folder_path 
  
 project 
 : 
  
 "_" 
 , 
  
 bucket 
 : 
  
 bucket_name 
 , 
  
 managed_folder 
 : 
  
 managed_folder_id 
  
 request 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Storage 
 :: 
 Control 
 :: 
 V2 
 :: 
 GetManagedFolderRequest 
 . 
 new 
  
 name 
 : 
  
 folder_path 
  
 response 
  
 = 
  
 storage_control 
 . 
 get_managed_folder 
  
 request 
  
 puts 
  
 "Got managed folder: 
 #{ 
 response 
 . 
 name 
 } 
 " 
 end

What's next

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

storage control get a managed folder Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

What's next

storage control get a managed folder