Publish with custom attributes

Publishes a message with custom attributes.

Explore further

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

Publish messages to topics

Code sample

C++

Before trying this sample, follow the C++ setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub C++ API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  namespace 
  
 pubsub 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 pubsub 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 future 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 pubsub 
 :: 
 Publisher 
  
 publisher 
 ) 
  
 { 
  
 std 
 :: 
 vector<future<void> 
>  
 done 
 ; 
  
 for 
  
 ( 
 int 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
  
 != 
  
 10 
 ; 
  
 ++ 
 i 
 ) 
  
 { 
  
 auto 
  
 message_id 
  
 = 
  
 publisher 
 . 
 Publish 
 ( 
  
 pubsub 
 :: 
 MessageBuilder 
 {} 
  
 . 
 SetData 
 ( 
 "Hello World! [" 
  
 + 
  
 std 
 :: 
 to_string 
 ( 
 i 
 ) 
  
 + 
  
 "]" 
 ) 
  
 . 
 SetAttribute 
 ( 
 "origin" 
 , 
  
 "cpp-sample" 
 ) 
  
 . 
 SetAttribute 
 ( 
 "username" 
 , 
  
 "gcp" 
 ) 
  
 . 
 Build 
 ()); 
  
 done 
 . 
 push_back 
 ( 
 message_id 
 . 
 then 
 ([ 
 i 
 ]( 
 future<StatusOr<std 
 :: 
 string 
>>  
 f 
 ) 
  
 { 
  
 auto 
  
 id 
  
 = 
  
 f 
 . 
 get 
 (); 
  
 if 
  
 ( 
 ! 
 id 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 id 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "Message " 
 << 
 i 
 << 
 " published with id=" 
 << 
 * 
 id 
 << 
 " 
 \n 
 " 
 ; 
  
 })); 
  
 } 
  
 publisher 
 . 
 Flush 
 (); 
  
 // Block until all the messages are published (optional) 
  
 for 
  
 ( 
 auto 
&  
 f 
  
 : 
  
 done 
 ) 
  
 f 
 . 
 get 
 (); 
 }

C#

Before trying this sample, follow the C# setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub C# API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  using 
  
  Google.Cloud.PubSub.V1 
 
 ; 
 using 
  
  Google.Protobuf 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Threading.Tasks 
 ; 
 public 
  
 class 
  
 PublishMessageWithCustomAttributesAsyncSample 
 { 
  
 public 
  
 async 
  
 Task 
  
 PublishMessageWithCustomAttributesAsync 
 ( 
 string 
  
 projectId 
 , 
  
 string 
  
 topicId 
 , 
  
 string 
  
 messageText 
 ) 
  
 { 
  
  TopicName 
 
  
 topicName 
  
 = 
  
  TopicName 
 
 . 
  FromProjectTopic 
 
 ( 
 projectId 
 , 
  
 topicId 
 ); 
  
  PublisherClient 
 
  
 publisher 
  
 = 
  
 await 
  
  PublisherClient 
 
 . 
  CreateAsync 
 
 ( 
 topicName 
 ); 
  
 var 
  
 pubsubMessage 
  
 = 
  
 new 
  
  PubsubMessage 
 
  
 { 
  
 // The data is any arbitrary ByteString. Here, we're using text. 
  
 Data 
  
 = 
  
  ByteString 
 
 . 
  CopyFromUtf8 
 
 ( 
 messageText 
 ), 
  
 // The attributes provide metadata in a string-to-string dictionary. 
  
 Attributes 
  
 = 
  
 { 
  
 { 
  
 "year" 
 , 
  
 "2020" 
  
 }, 
  
 { 
  
 "author" 
 , 
  
 "unknown" 
  
 } 
  
 } 
  
 }; 
  
 string 
  
 message 
  
 = 
  
 await 
  
 publisher 
 . 
  PublishAsync 
 
 ( 
 pubsubMessage 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Published message {message}" 
 ); 
  
 // PublisherClient instance should be shutdown after use. 
  
 // The TimeSpan specifies for how long to attempt to publish locally queued messages. 
  
 await 
  
 publisher 
 . 
  ShutdownAsync 
 
 ( 
 TimeSpan 
 . 
 FromSeconds 
 ( 
 15 
 )); 
  
 } 
 }

Go

Before trying this sample, follow the Go setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Go API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "cloud.google.com/go/pubsub/v2" 
 ) 
 func 
  
 publishCustomAttributes 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 topicID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // topicID := "my-topic" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 pubsub 
 . 
 NewClient 
 ( 
 ctx 
 , 
  
 projectID 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "pubsub.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 // client.Publisher can be passed a topic ID (e.g. "my-topic") or 
  
 // a fully qualified name (e.g. "projects/my-project/topics/my-topic"). 
  
 // If a topic ID is provided, the project ID from the client is used. 
  
 // Reuse this publisher for all publish calls to send messages in batches. 
  
 publisher 
  
 := 
  
 client 
 . 
 Publisher 
 ( 
 topicID 
 ) 
  
 result 
  
 := 
  
 publisher 
 . 
 Publish 
 ( 
 ctx 
 , 
  
& pubsub 
 . 
 Message 
 { 
  
 Data 
 : 
  
 [] 
 byte 
 ( 
 "Hello world!" 
 ), 
  
 Attributes 
 : 
  
 map 
 [ 
 string 
 ] 
 string 
 { 
  
 "origin" 
 : 
  
 "golang" 
 , 
  
 "username" 
 : 
  
 "gcp" 
 , 
  
 }, 
  
 }) 
  
 // Block until the result is returned and a server-generated 
  
 // ID is returned for the published message. 
  
 id 
 , 
  
 err 
  
 := 
  
 result 
 . 
 Get 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Get: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Published message with custom attributes; msg ID: %v\n" 
 , 
  
 id 
 ) 
  
 return 
  
 nil 
 }

Java

Before trying this sample, follow the Java setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Java API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.api.core. ApiFuture 
 
 ; 
 import 
  
 com.google.cloud.pubsub.v1. Publisher 
 
 ; 
 import 
  
 com.google.common.collect.ImmutableMap 
 ; 
 import 
  
 com.google.protobuf. ByteString 
 
 ; 
 import 
  
 com.google.pubsub.v1. PubsubMessage 
 
 ; 
 import 
  
 com.google.pubsub.v1. TopicName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 public 
  
 class 
 PublishWithCustomAttributesExample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 ... 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 topicId 
  
 = 
  
 "your-topic-id" 
 ; 
  
 publishWithCustomAttributesExample 
 ( 
 projectId 
 , 
  
 topicId 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 publishWithCustomAttributesExample 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 topicId 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
  
 { 
  
  TopicName 
 
  
 topicName 
  
 = 
  
  TopicName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 topicId 
 ); 
  
  Publisher 
 
  
 publisher 
  
 = 
  
 null 
 ; 
  
 try 
  
 { 
  
 // Create a publisher instance with default settings bound to the topic 
  
 publisher 
  
 = 
  
  Publisher 
 
 . 
 newBuilder 
 ( 
 topicName 
 ). 
 build 
 (); 
  
 String 
  
 message 
  
 = 
  
 "first message" 
 ; 
  
  ByteString 
 
  
 data 
  
 = 
  
  ByteString 
 
 . 
  copyFromUtf8 
 
 ( 
 message 
 ); 
  
  PubsubMessage 
 
  
 pubsubMessage 
  
 = 
  
  PubsubMessage 
 
 . 
 newBuilder 
 () 
  
 . 
  setData 
 
 ( 
 data 
 ) 
  
 . 
 putAllAttributes 
 ( 
 ImmutableMap 
 . 
 of 
 ( 
 "year" 
 , 
  
 "2020" 
 , 
  
 "author" 
 , 
  
 "unknown" 
 )) 
  
 . 
 build 
 (); 
  
 // Once published, returns a server-assigned message id (unique within the topic) 
  
 ApiFuture<String> 
  
 messageIdFuture 
  
 = 
  
  publish 
 
er . 
  publish 
 
 ( 
 pubsubMessage 
 ); 
  
 String 
  
 messageId 
  
 = 
  
 messageIdFuture 
 . 
 get 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Published a message with custom attributes: " 
  
 + 
  
 messageId 
 ); 
  
 } 
  
 finally 
  
 { 
  
 if 
  
 ( 
 publisher 
  
 != 
  
 null 
 ) 
  
 { 
  
 // When finished with the publisher, shutdown to free up resources. 
  
 publisher 
 . 
  shutdown 
 
 (); 
  
 publisher 
 . 
  awaitTermination 
 
 ( 
 1 
 , 
  
 TimeUnit 
 . 
 MINUTES 
 ); 
  
 } 
  
 } 
  
 } 
 }

Node.js

Before trying this sample, follow the Node.js setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Node.js API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  /** 
  
 * 
  
 TODO 
 ( 
 developer 
 ): 
  
 Uncomment 
  
 these 
  
 variables 
  
 before 
  
 running 
  
 the 
  
 sample 
 . 
  
 */ 
 // 
  
 const 
  
 topicNameOrId 
  
 = 
  
 'YOUR_TOPIC_NAME_OR_ID' 
 ; 
 // 
  
 const 
  
 data 
  
 = 
  
 JSON 
 . 
 stringify 
 ({ 
 foo 
 : 
  
 'bar' 
 }); 
 // 
  
 Imports 
  
 the 
  
 Google 
  
 Cloud 
  
 client 
  
 library 
 const 
  
 { 
 PubSub 
 } 
  
 = 
  
 require 
 ( 
 '@google-cloud/pubsub' 
 ); 
 // 
  
 Creates 
  
 a 
  
 client 
 ; 
  
 cache 
  
 this 
  
 for 
  
 further 
  
 use 
 const 
  
 pubSubClient 
  
 = 
  
 new 
  
 PubSub 
 (); 
 async 
  
 function 
  
 publishMessageWithCustomAttributes 
 ( 
 topicNameOrId 
 , 
  
 data 
 ) 
  
 { 
  
 // 
  
 Publishes 
  
 the 
  
 message 
  
 as 
  
 a 
  
 string 
 , 
  
 e 
 . 
 g 
 . 
  
 "Hello, world!" 
  
 or 
  
 JSON 
 . 
 stringify 
 ( 
 someObject 
 ) 
  
 const 
  
 dataBuffer 
  
 = 
  
 Buffer 
 . 
 from 
 ( 
 data 
 ); 
  
 // 
  
 Add 
  
 two 
  
 custom 
  
 attributes 
 , 
  
 origin 
  
 and 
  
 username 
 , 
  
 to 
  
 the 
  
 message 
  
 const 
  
 customAttributes 
  
 = 
  
 { 
  
 origin 
 : 
  
 'nodejs-sample' 
 , 
  
 username 
 : 
  
 'gcp' 
 , 
  
 }; 
  
 // 
  
 Cache 
  
 topic 
  
 objects 
  
 ( 
 publishers 
 ) 
  
 and 
  
 reuse 
  
 them 
 . 
  
 const 
  
 topic 
  
 = 
  
 pubSubClient 
 . 
 topic 
 ( 
 topicNameOrId 
 ); 
  
 const 
  
 messageId 
  
 = 
  
 await 
  
 topic 
 . 
 publishMessage 
 ({ 
  
 data 
 : 
  
 dataBuffer 
 , 
  
 attributes 
 : 
  
 customAttributes 
 , 
  
 }); 
  
 console 
 . 
 log 
 ( 
 ` 
 Message 
  
 $ 
 { 
 messageId 
 } 
  
 published 
 . 
 ` 
 ); 
 }

Node.js

Before trying this sample, follow the Node.js setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Node.js API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  /** 
 * 
 TODO 
 ( 
 developer 
 ): 
 Uncomment 
 these 
 variables 
 before 
 running 
 the 
 sample 
 . 
 */ 
 // 
 const 
 topicNameOrId 
 = 
 'YOUR_TOPIC_NAME_OR_ID' 
 ; 
 // 
 const 
 data 
 = 
 JSON 
 . 
 stringify 
 ({ 
 foo 
 : 
 'bar' 
 }); 
 // 
 Imports 
 the 
 Google 
 Cloud 
 client 
 library 
 import 
  
 { 
 PubSub 
 } 
 from 
  
 '@google-cloud/pubsub' 
 ; 
 // 
 Creates 
 a 
 client 
 ; 
 cache 
 this 
 for 
 further 
 use 
 const 
 pubSubClient 
 = 
 new 
 PubSub 
 (); 
 interface 
 Attributes 
 { 
 [ 
 k 
 : 
 string 
 ]: 
 string 
 ; 
 } 
 async 
 function 
 publishMessageWithCustomAttributes 
 ( 
 topicNameOrId 
 : 
 string 
 , 
 data 
 : 
 string 
 , 
 ) 
 { 
 // 
 Publishes 
 the 
 message 
 as 
 a 
 string 
 , 
 e 
 . 
 g 
 . 
 "Hello, world!" 
 or 
 JSON 
 . 
 stringify 
 ( 
 someObject 
 ) 
 const 
 dataBuffer 
 = 
 Buffer 
 . 
 from 
 ( 
 data 
 ); 
 // 
 Add 
 two 
 custom 
 attributes 
 , 
 origin 
 and 
 username 
 , 
 to 
 the 
 message 
 const 
 customAttributes 
 : 
 Attributes 
 = 
 { 
 origin 
 : 
 'nodejs-sample' 
 , 
 username 
 : 
 'gcp' 
 , 
 }; 
 // 
 Cache 
 topic 
 objects 
 ( 
 publishers 
 ) 
 and 
 reuse 
 them 
 . 
 const 
 topic 
 = 
 pubSubClient 
 . 
 topic 
 ( 
 topicNameOrId 
 ); 
 const 
 messageId 
 = 
 await 
 topic 
 . 
 publishMessage 
 ({ 
 data 
 : 
 dataBuffer 
 , 
 attributes 
 : 
 customAttributes 
 , 
 }); 
 console 
 . 
 log 
 ( 
 ` 
 Message 
 $ 
 { 
 messageId 
 } 
 published 
 . 
 ` 
 ); 
 }

Python

Before trying this sample, follow the Python setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Python API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 google.cloud 
  
 import 
 pubsub_v1 
 # TODO(developer) 
 # project_id = "your-project-id" 
 # topic_id = "your-topic-id" 
 publisher 
 = 
 pubsub_v1 
 . 
  PublisherClient 
 
 () 
 topic_path 
 = 
 publisher 
 . 
 topic_path 
 ( 
 project_id 
 , 
 topic_id 
 ) 
 for 
 n 
 in 
 range 
 ( 
 1 
 , 
 10 
 ): 
 data_str 
 = 
 f 
 "Message number 
 { 
 n 
 } 
 " 
 # Data must be a bytestring 
 data 
 = 
 data_str 
 . 
 encode 
 ( 
 "utf-8" 
 ) 
 # Add two attributes, origin and username, to the message 
 future 
 = 
  publish 
 
er . 
  publish 
 
 ( 
 topic_path 
 , 
 data 
 , 
 origin 
 = 
 "python-sample" 
 , 
 username 
 = 
 "gcp" 
 ) 
 print 
 ( 
 future 
 . 
 result 
 ()) 
 print 
 ( 
 f 
 "Published messages with custom attributes to 
 { 
 topic_path 
 } 
 ." 
 )

Ruby

Before trying this sample, follow the Ruby setup instructions in the Pub/Sub quickstart using client libraries . For more information, see the Pub/Sub Ruby API reference documentation .

To authenticate to Pub/Sub, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  # topic_id = "your-topic-id" 
 pubsub 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  PubSub 
 
 . 
  new 
 
 publisher 
  
 = 
  
 pubsub 
 . 
  publisher 
 
  
 topic_id 
 # Add two attributes, origin and username, to the message 
 publisher 
 . 
  publish_async 
 
  
 "This is a test message." 
 , 
  
 origin 
 : 
  
 "ruby-sample" 
 , 
  
 username 
 : 
  
 "gcp" 
  
 do 
  
 | 
 result 
 | 
  
 raise 
  
 "Failed to publish the message." 
  
 unless 
  
 result 
 . 
 succeeded? 
  
 puts 
  
 "Message with custom attributes published asynchronously." 
 end 
 # Stop the async_publisher to send all queued messages immediately. 
 publisher 
 . 
  async_publisher 
 
 . 
 stop 
 . 
 wait!

What's next

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

Publish with custom attributes Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

C++

C#

Go

Java

Node.js

Node.js

Python

Ruby

What's next

Publish with custom attributes