Class PublisherClient (2.34.0-rc)

Version latest

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Eventarc processes events generated by an event provider and delivers them to a subscriber.

An event provider is a software-as-a-service (SaaS) system or product that can generate and deliver events through Eventarc.

A third-party event provider is an event provider from outside of Google.

A partner is a third-party event provider that is integrated with Eventarc.

A subscriber is a GCP customer interested in receiving events.

Channel is a first-class Eventarc resource that is created and managed by the subscriber in their GCP project. A Channel represents a subscriber's intent to receive events from an event provider. A Channel is associated with exactly one event provider.

ChannelConnection is a first-class Eventarc resource that is created and managed by the partner in their GCP project. A ChannelConnection represents a connection between a partner and a subscriber's Channel. A ChannelConnection has a one-to-one mapping with a Channel.

Publisher allows an event provider to publish events to Eventarc.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

PublisherClient(PublisherClient const &)

Copy and move support

Parameter
Name	Description
	PublisherClient const &

PublisherClient(PublisherClient &&)

Copy and move support

Parameter
Name	Description
	PublisherClient &&

PublisherClient(std::shared_ptr< PublisherConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< PublisherConnection >
opts	Options

Operators

operator=(PublisherClient const &)

Copy and move support

Parameter
Name	Description
	PublisherClient const &

Returns
Type	Description
PublisherClient &

operator=(PublisherClient &&)

Copy and move support

Parameter
Name	Description
	PublisherClient &&

Returns
Type	Description
PublisherClient &

Functions

PublishChannelConnectionEvents(google::cloud::eventarc::publishing::v1::PublishChannelConnectionEventsRequest const &, Options)

Publish events to a ChannelConnection in a partner's project.

Parameters
Name	Description
request	google::cloud::eventarc::publishing::v1::PublishChannelConnectionEventsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::eventarc::publishing::v1::PublishChannelConnectionEventsResponse >	the result of the RPC. The response message type (google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PublishEvents(google::cloud::eventarc::publishing::v1::PublishEventsRequest const &, Options)

Publish events to a subscriber's channel.

Parameters
Name	Description
request	google::cloud::eventarc::publishing::v1::PublishEventsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.publishing.v1.PublishEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::eventarc::publishing::v1::PublishEventsResponse >	the result of the RPC. The response message type (google.cloud.eventarc.publishing.v1.PublishEventsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Publish(google::cloud::eventarc::publishing::v1::PublishRequest const &, Options)

Publish events to a message bus.

Parameters
Name	Description
request	google::cloud::eventarc::publishing::v1::PublishRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.publishing.v1.PublishRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::eventarc::publishing::v1::PublishResponse >	the result of the RPC. The response message type (google.cloud.eventarc.publishing.v1.PublishResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.