Class NotificationChannelServiceClient (2.15.1)

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

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

NotificationChannelServiceClient(NotificationChannelServiceClient const &)

Copy and move support

Parameter
NameDescription
NotificationChannelServiceClient const &

NotificationChannelServiceClient(NotificationChannelServiceClient &&)

Copy and move support

Parameter
NameDescription
NotificationChannelServiceClient &&

NotificationChannelServiceClient(std::shared_ptr< NotificationChannelServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< NotificationChannelServiceConnection >
opts Options

Operators

operator=(NotificationChannelServiceClient const &)

Copy and move support

Parameter
NameDescription
NotificationChannelServiceClient const &
Returns
TypeDescription
NotificationChannelServiceClient &

operator=(NotificationChannelServiceClient &&)

Copy and move support

Parameter
NameDescription
NotificationChannelServiceClient &&
Returns
TypeDescription
NotificationChannelServiceClient &

Functions

ListNotificationChannelDescriptors(std::string const &, Options)

Lists the descriptors for supported channel types.

The use of descriptors makes it possible for new channel types to be dynamically added.

Parameters
NameDescription
name std::string const &

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor] operation, instead.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::monitoring::v3::NotificationChannelDescriptor >

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.monitoring.v3.NotificationChannelDescriptor, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNotificationChannelDescriptors(google::monitoring::v3::ListNotificationChannelDescriptorsRequest, Options)

Lists the descriptors for supported channel types.

The use of descriptors makes it possible for new channel types to be dynamically added.

Parameters
NameDescription
request google::monitoring::v3::ListNotificationChannelDescriptorsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs