Publish Event Messages with Pub/Sub API

The Pub/Sub API service is defined in a proto file, with RPC method parameters and return types specified as protocol buffer messages. When an event is published through one of the publish RPC methods, the publish request is serialized based on the protocol buffer message type. For more information, see What is gRPC? and Protocol Buffers in the gRPC documentation, and pubsub_api.proto in the Pub/Sub API GitHub repository.

Publish events by using one of two RPC methods: Publish and PublishStream.

The Publish RPC method is a unary RPC, which means that it sends only one request and receives only one response.

rpc Publish (PublishRequest) returns (PublishResponse);

The PublishStream RPC method uses bidirectional streaming. It can send a stream of publish requests while receiving a stream of publish responses from the server. Use PublishStream to achieve a higher publish rate than with Publish.

rpc PublishStream (stream PublishRequest) returns (stream PublishResponse);

The PublishResponse holds a PublishResult for each event published that indicates the final success or failure of the publish operation, and not the intermediate queueing results. A successful status means that the event was published. A failed status means that the event failed to publish, and the client can retry publishing this event.

To learn more about the RPC methods in Pub/Sub API, see Pub/Sub API RPC Method Reference in the Pub/Sub API Developer Guide.

Write a Pub/Sub API client to publish platform event messages. You can use one of the 11 supported programming languages, including Python, Java, Go, and Node. To learn how to write a client in Java or Python, check out Quick Starts in the Pub/Sub API Developer Guide. For code examples in other languages, see the Pub/Sub API GitHub repository.