Class EventarcClient (2.28.0)

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.GetTriggerRequest. 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::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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Trigger, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.ListTriggersRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Trigger, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTrigger(NoAwaitTag, std::string const &, google::cloud::eventarc::v1::Trigger const &, std::string const &, Options)

Create a new trigger in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
trigger google::cloud::eventarc::v1::Trigger const &
trigger_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.CreateTriggerRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTrigger(NoAwaitTag, google::cloud::eventarc::v1::CreateTriggerRequest const &, Options)

Create a new trigger in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::CreateTriggerRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTrigger(google::longrunning::Operation const &, Options)

Create a new trigger in a particular project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

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, update_mask is ignored.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTrigger(NoAwaitTag, google::cloud::eventarc::v1::Trigger const &, google::protobuf::FieldMask const &, bool, Options)

Update a single trigger.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
trigger google::cloud::eventarc::v1::Trigger const &
update_mask google::protobuf::FieldMask const &
allow_missing bool
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.UpdateTriggerRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTrigger(NoAwaitTag, google::cloud::eventarc::v1::UpdateTriggerRequest const &, Options)

Update a single trigger.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::UpdateTriggerRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTrigger(google::longrunning::Operation const &, Options)

Update a single trigger.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTrigger(NoAwaitTag, std::string const &, bool, Options)

Delete a single trigger.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
allow_missing bool
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.DeleteTriggerRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Trigger proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTrigger(NoAwaitTag, google::cloud::eventarc::v1::DeleteTriggerRequest const &, Options)

Delete a single trigger.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::DeleteTriggerRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTrigger(google::longrunning::Operation const &, Options)

Delete a single trigger.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Trigger > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.GetChannelRequest. 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::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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Channel, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.ListChannelsRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Channel, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateChannel(NoAwaitTag, std::string const &, google::cloud::eventarc::v1::Channel const &, std::string const &, Options)

Create a new channel in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
channel google::cloud::eventarc::v1::Channel const &
channel_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.CreateChannelRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Channel > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateChannel(NoAwaitTag, google::cloud::eventarc::v1::CreateChannelRequest const &, Options)

Create a new channel in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::CreateChannelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateChannel(google::longrunning::Operation const &, Options)

Create a new channel in a particular project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Channel > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateChannel(NoAwaitTag, google::cloud::eventarc::v1::Channel const &, google::protobuf::FieldMask const &, Options)

Update a single channel.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
channel google::cloud::eventarc::v1::Channel const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.UpdateChannelRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Channel > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateChannel(NoAwaitTag, google::cloud::eventarc::v1::UpdateChannelRequest const &, Options)

Update a single channel.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::UpdateChannelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateChannel(google::longrunning::Operation const &, Options)

Update a single channel.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Channel > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteChannel(NoAwaitTag, std::string const &, Options)

Delete a single channel.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.DeleteChannelRequest. 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
future< StatusOr< google::cloud::eventarc::v1::Channel > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteChannel(NoAwaitTag, google::cloud::eventarc::v1::DeleteChannelRequest const &, Options)

Delete a single channel.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::DeleteChannelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteChannel(google::longrunning::Operation const &, Options)

Delete a single channel.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::Channel > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.GetProviderRequest. 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::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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Provider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.ListProvidersRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.Provider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.GetChannelConnectionRequest. 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::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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.ChannelConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.ListChannelConnectionsRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.eventarc.v1.ChannelConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.ChannelConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateChannelConnection(NoAwaitTag, std::string const &, google::cloud::eventarc::v1::ChannelConnection const &, std::string const &, Options)

Create a new ChannelConnection in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
channel_connection google::cloud::eventarc::v1::ChannelConnection const &
channel_connection_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.CreateChannelConnectionRequest. 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
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.ChannelConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateChannelConnection(NoAwaitTag, google::cloud::eventarc::v1::CreateChannelConnectionRequest const &, Options)

Create a new ChannelConnection in a particular project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::CreateChannelConnectionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateChannelConnection(google::longrunning::Operation const &, Options)

Create a new ChannelConnection in a particular project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.ChannelConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteChannelConnection(NoAwaitTag, std::string const &, Options)

Delete a single ChannelConnection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.DeleteChannelConnectionRequest. 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
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.eventarc.v1.ChannelConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteChannelConnection(NoAwaitTag, google::cloud::eventarc::v1::DeleteChannelConnectionRequest const &, Options)

Delete a single ChannelConnection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::eventarc::v1::DeleteChannelConnectionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteChannelConnection(google::longrunning::Operation const &, Options)

Delete a single ChannelConnection.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::eventarc::v1::ChannelConnection > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.GetGoogleChannelConfigRequest. 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::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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.eventarc.v1.UpdateGoogleChannelConfigRequest. 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::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 StatusOr contains the error details.