Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.
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
EventarcClient(EventarcClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EventarcClient const &
|
EventarcClient(EventarcClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EventarcClient &&
|
EventarcClient(std::shared_ptr< EventarcConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< EventarcConnection >
|
opts |
Options
|
Operators
operator=(EventarcClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EventarcClient const &
|
Returns | |
---|---|
Type | Description |
EventarcClient & |
operator=(EventarcClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EventarcClient &&
|
Returns | |
---|---|
Type | Description |
EventarcClient & |
Functions
GetTrigger(std::string const &, Options)
Get a single trigger.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the trigger to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Trigger > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Trigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrigger(google::cloud::eventarc::v1::GetTriggerRequest const &, Options)
Get a single trigger.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::GetTriggerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Trigger > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Trigger) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTriggers(std::string const &, Options)
List triggers.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection to list triggers on. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Trigger > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTriggers(google::cloud::eventarc::v1::ListTriggersRequest, Options)
List triggers.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::ListTriggersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Trigger > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateTrigger(std::string const &, google::cloud::eventarc::v1::Trigger const &, std::string const &, Options)
Create a new trigger in a particular project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection in which to add this trigger. |
trigger |
google::cloud::eventarc::v1::Trigger const &
Required. The trigger to create. |
trigger_id |
std::string const &
Required. The user-provided ID to be assigned to the trigger. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
CreateTrigger(google::cloud::eventarc::v1::CreateTriggerRequest const &, Options)
Create a new trigger in a particular project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::CreateTriggerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
UpdateTrigger(google::cloud::eventarc::v1::Trigger const &, google::protobuf::FieldMask const &, bool, Options)
Update a single trigger.
Parameters | |
---|---|
Name | Description |
trigger |
google::cloud::eventarc::v1::Trigger const &
The trigger to be updated. |
update_mask |
google::protobuf::FieldMask const &
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
allow_missing |
bool
If set to true, and the trigger is not found, a new trigger will be created. In this situation, |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
UpdateTrigger(google::cloud::eventarc::v1::UpdateTriggerRequest const &, Options)
Update a single trigger.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::UpdateTriggerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
DeleteTrigger(std::string const &, bool, Options)
Delete a single trigger.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the trigger to be deleted. |
allow_missing |
bool
If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
DeleteTrigger(google::cloud::eventarc::v1::DeleteTriggerRequest const &, Options)
Delete a single trigger.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::DeleteTriggerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Trigger > > | A |
GetChannel(std::string const &, Options)
Get a single Channel.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the channel to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Channel > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Channel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetChannel(google::cloud::eventarc::v1::GetChannelRequest const &, Options)
Get a single Channel.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::GetChannelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Channel > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Channel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListChannels(std::string const &, Options)
List channels.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection to list channels on. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Channel > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListChannels(google::cloud::eventarc::v1::ListChannelsRequest, Options)
List channels.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::ListChannelsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Channel > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateChannel(std::string const &, google::cloud::eventarc::v1::Channel const &, std::string const &, Options)
Create a new channel in a particular project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection in which to add this channel. |
channel |
google::cloud::eventarc::v1::Channel const &
Required. The channel to create. |
channel_id |
std::string const &
Required. The user-provided ID to be assigned to the channel. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
CreateChannel(google::cloud::eventarc::v1::CreateChannelRequest const &, Options)
Create a new channel in a particular project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::CreateChannelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
UpdateChannel(google::cloud::eventarc::v1::Channel const &, google::protobuf::FieldMask const &, Options)
Update a single channel.
Parameters | |
---|---|
Name | Description |
channel |
google::cloud::eventarc::v1::Channel const &
The channel to be updated. |
update_mask |
google::protobuf::FieldMask const &
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
UpdateChannel(google::cloud::eventarc::v1::UpdateChannelRequest const &, Options)
Update a single channel.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::UpdateChannelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
DeleteChannel(std::string const &, Options)
Delete a single channel.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the channel to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
DeleteChannel(google::cloud::eventarc::v1::DeleteChannelRequest const &, Options)
Delete a single channel.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::DeleteChannelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::Channel > > | A |
GetProvider(std::string const &, Options)
Get a single Provider.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the provider to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Provider > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Provider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetProvider(google::cloud::eventarc::v1::GetProviderRequest const &, Options)
Get a single Provider.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::GetProviderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::Provider > | the result of the RPC. The response message type (google.cloud.eventarc.v1.Provider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListProviders(std::string const &, Options)
List providers.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent of the provider to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Provider > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListProviders(google::cloud::eventarc::v1::ListProvidersRequest, Options)
List providers.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::ListProvidersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::Provider > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetChannelConnection(std::string const &, Options)
Get a single ChannelConnection.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the channel connection to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::ChannelConnection > | the result of the RPC. The response message type (google.cloud.eventarc.v1.ChannelConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetChannelConnection(google::cloud::eventarc::v1::GetChannelConnectionRequest const &, Options)
Get a single ChannelConnection.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::GetChannelConnectionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::ChannelConnection > | the result of the RPC. The response message type (google.cloud.eventarc.v1.ChannelConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListChannelConnections(std::string const &, Options)
List channel connections.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection from which to list channel connections. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::ChannelConnection > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListChannelConnections(google::cloud::eventarc::v1::ListChannelConnectionsRequest, Options)
List channel connections.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::ListChannelConnectionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::eventarc::v1::ChannelConnection > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateChannelConnection(std::string const &, google::cloud::eventarc::v1::ChannelConnection const &, std::string const &, Options)
Create a new ChannelConnection in a particular project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection in which to add this channel connection. |
channel_connection |
google::cloud::eventarc::v1::ChannelConnection const &
Required. Channel connection to create. |
channel_connection_id |
std::string const &
Required. The user-provided ID to be assigned to the channel connection. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > > | A |
CreateChannelConnection(google::cloud::eventarc::v1::CreateChannelConnectionRequest const &, Options)
Create a new ChannelConnection in a particular project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::CreateChannelConnectionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > > | A |
DeleteChannelConnection(std::string const &, Options)
Delete a single ChannelConnection.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the channel connection to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > > | A |
DeleteChannelConnection(google::cloud::eventarc::v1::DeleteChannelConnectionRequest const &, Options)
Delete a single ChannelConnection.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::DeleteChannelConnectionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > > | A |
GetGoogleChannelConfig(std::string const &, Options)
Get a GoogleChannelConfig.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the config to get. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::GoogleChannelConfig > | the result of the RPC. The response message type (google.cloud.eventarc.v1.GoogleChannelConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetGoogleChannelConfig(google::cloud::eventarc::v1::GetGoogleChannelConfigRequest const &, Options)
Get a GoogleChannelConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::GetGoogleChannelConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::GoogleChannelConfig > | the result of the RPC. The response message type (google.cloud.eventarc.v1.GoogleChannelConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGoogleChannelConfig(google::cloud::eventarc::v1::GoogleChannelConfig const &, google::protobuf::FieldMask const &, Options)
Update a single GoogleChannelConfig.
Parameters | |
---|---|
Name | Description |
google_channel_config |
google::cloud::eventarc::v1::GoogleChannelConfig const &
Required. The config to be updated. |
update_mask |
google::protobuf::FieldMask const &
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::GoogleChannelConfig > | the result of the RPC. The response message type (google.cloud.eventarc.v1.GoogleChannelConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGoogleChannelConfig(google::cloud::eventarc::v1::UpdateGoogleChannelConfigRequest const &, Options)
Update a single GoogleChannelConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::eventarc::v1::UpdateGoogleChannelConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::eventarc::v1::GoogleChannelConfig > | the result of the RPC. The response message type (google.cloud.eventarc.v1.GoogleChannelConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |