Class AdvisoryNotificationsServiceClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 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

Service to manage Security and Privacy Notifications.

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

AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceClient const &)

Copy and move support

Parameter
Name	Description
	AdvisoryNotificationsServiceClient const &

AdvisoryNotificationsServiceClient(AdvisoryNotificationsServiceClient &&)

Copy and move support

Parameter
Name	Description
	AdvisoryNotificationsServiceClient &&

AdvisoryNotificationsServiceClient(std::shared_ptr< AdvisoryNotificationsServiceConnection >, Options)

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

Operators

operator=(AdvisoryNotificationsServiceClient const &)

Copy and move support

Parameter
Name	Description
	AdvisoryNotificationsServiceClient const &

Returns
Type	Description
AdvisoryNotificationsServiceClient &

operator=(AdvisoryNotificationsServiceClient &&)

Copy and move support

Parameter
Name	Description
	AdvisoryNotificationsServiceClient &&

Returns
Type	Description
AdvisoryNotificationsServiceClient &

Functions

ListNotifications(std::string const &, Options)

Lists notifications under a given parent.

Parameters
Name	Description
parent	std::string const & Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}"
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::advisorynotifications::v1::Notification >	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.advisorynotifications.v1.Notification, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNotifications(google::cloud::advisorynotifications::v1::ListNotificationsRequest, Options)

Lists notifications under a given parent.

Parameters
Name	Description
request	google::cloud::advisorynotifications::v1::ListNotificationsRequest 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.advisorynotifications.v1.ListNotificationsRequest. 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::advisorynotifications::v1::Notification >	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.advisorynotifications.v1.Notification, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetNotification(std::string const &, Options)

Gets a notification.

Parameters
Name	Description
name	std::string const & Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetNotification(google::cloud::advisorynotifications::v1::GetNotificationRequest const &, Options)

Gets a notification.

Parameters
Name	Description
request	google::cloud::advisorynotifications::v1::GetNotificationRequest 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.advisorynotifications.v1.GetNotificationRequest. 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::advisorynotifications::v1::Notification >	the result of the RPC. The response message type (google.cloud.advisorynotifications.v1.Notification) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSettings(std::string const &, Options)

Get notification settings.

Parameters
Name	Description
name	std::string const & Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetSettings(google::cloud::advisorynotifications::v1::GetSettingsRequest const &, Options)

Get notification settings.

Parameters
Name	Description
request	google::cloud::advisorynotifications::v1::GetSettingsRequest 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.advisorynotifications.v1.GetSettingsRequest. 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::advisorynotifications::v1::Settings >	the result of the RPC. The response message type (google.cloud.advisorynotifications.v1.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSettings(google::cloud::advisorynotifications::v1::Settings const &, Options)

Update notification settings.

Parameters
Name	Description
settings	google::cloud::advisorynotifications::v1::Settings const & Required. New settings.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateSettings(google::cloud::advisorynotifications::v1::UpdateSettingsRequest const &, Options)

Update notification settings.

Parameters
Name	Description
request	google::cloud::advisorynotifications::v1::UpdateSettingsRequest 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.advisorynotifications.v1.UpdateSettingsRequest. 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::advisorynotifications::v1::Settings >	the result of the RPC. The response message type (google.cloud.advisorynotifications.v1.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.