List Pub/Sub notifications

List the Pub/Sub notifications set up for a Cloud Storage storage bucket.

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 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 StatusOr<std 
 :: 
 vector<gcs 
 :: 
 NotificationMetadata 
>>  
 items 
  
 = 
  
 client 
 . 
 ListNotifications 
 ( 
 bucket_name 
 ); 
  
 if 
  
 ( 
 ! 
 items 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 items 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Notifications for bucket=" 
 << 
 bucket_name 
 << 
 " 
 \n 
 " 
 ; 
  
 for 
  
 ( 
 gcs 
 :: 
 NotificationMetadata 
  
 const 
&  
 notification 
  
 : 
  
 * 
 items 
 ) 
  
 { 
  
 std 
 :: 
 cout 
 << 
 notification 
 << 
 " 
 \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.Apis.Storage.v1.Data 
 ; 
 using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 public 
  
 class 
  
 ListPubSubNotificationSample 
 { 
  
 public 
  
 IReadOnlyList<Notification> 
  
 ListPubSubNotification 
 ( 
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 ) 
  
 { 
  
  StorageClient 
 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 IReadOnlyList<Notification> 
  
 notifications 
  
 = 
  
 storage 
 . 
  ListNotifications 
 
 ( 
 bucketName 
 ); 
  
 foreach 
  
 ( 
 Notification 
  
 notification 
  
 in 
  
 notifications 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 notification 
 . 
 Id 
 ); 
  
 } 
  
 return 
  
 notifications 
 ; 
  
 } 
 } 
 

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" 
  
 "cloud.google.com/go/storage" 
 ) 
 // listBucketNotifications lists notification configurations for a bucket. 
 func 
  
 listBucketNotifications 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 notifications 
 , 
  
 err 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ). 
  Notifications 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket.Notifications: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 for 
  
 nID 
 , 
  
 n 
  
 := 
  
 range 
  
 notifications 
  
 { 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Notification topic %s with ID %s\n" 
 , 
  
 n 
 . 
 TopicID 
 , 
  
 nID 
 ) 
  
 } 
  
 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.cloud.storage. Notification 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 import 
  
 java.util.List 
 ; 
 public 
  
 class 
 ListPubSubNotifications 
  
 { 
  
 public 
  
 static 
  
 void 
  
 listPubSubNotifications 
 ( 
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID to give your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 build 
 (). 
  getService 
 
 (); 
  
 List<Notification> 
  
 notificationList 
  
 = 
  
 storage 
 . 
  listNotifications 
 
 ( 
 bucketName 
 ); 
  
 for 
  
 ( 
  Notification 
 
  
 notification 
  
 : 
  
 notificationList 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
  
 "Found notification " 
  
 + 
  
 notification 
 . 
  getTopic 
 
 () 
  
 + 
  
 " for bucket " 
  
 + 
  
 bucketName 
 ); 
  
 } 
  
 } 
 } 
 

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 the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 listNotifications 
 () 
  
 { 
  
 // Lists notifications in the bucket 
  
 const 
  
 [ 
 notifications 
 ] 
  
 = 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
  getNotifications 
 
 (); 
  
 console 
 . 
 log 
 ( 
 'Notifications:' 
 ); 
  
 notifications 
 . 
 forEach 
 ( 
 notification 
  
 = 
>  
 { 
  
 console 
 . 
 log 
 ( 
  notification 
 
 . 
 id 
 ); 
  
 }); 
 } 
 listNotifications 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 ); 
 

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\StorageClient; 
 /** 
 * Lists notification configurations for a bucket. 
 * This sample is used on this page: 
 *   https://cloud.google.com/storage/docs/reporting-changes 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'your-bucket') 
 */ 
 function list_bucket_notifications( 
 string $bucketName 
 ): void { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $notifications = $bucket->notifications(); 
 foreach ($notifications as $notification) { 
 printf('Found notification with id %s' . PHP_EOL, $notification->id()); 
 } 
 printf( 
 'Listed %s notifications of storage bucket %s.' . PHP_EOL, 
 iterator_count($notifications), 
 $bucketName, 
 ); 
 } 
 

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 
 
 def 
  
 list_bucket_notifications 
 ( 
 bucket_name 
 ): 
  
 """Lists notification configurations for a bucket.""" 
 # The ID of your GCS bucket 
 # bucket_name = "your-bucket-name" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  bucket 
 
 ( 
 bucket_name 
 ) 
 notifications 
 = 
 bucket 
 . 
  list_notifications 
 
 () 
 for 
 notification 
 in 
 notifications 
 : 
 print 
 ( 
 f 
 "Notification ID: 
 { 
 notification 
 . 
  notification_id 
 
 } 
 " 
 ) 
 

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" 
 def 
  
 list_bucket_notifications 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
  notifications 
 
 . 
  each 
 
  
 do 
  
 | 
 notification 
 | 
  
 puts 
  
 "Notification ID: 
 #{ 
 notification 
 . 
 id 
 } 
 " 
  
 end 
 end 
 

What's next

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

Create a Mobile Website
View Site in Mobile | Classic
Share by: