Class SnoozeServiceClient (2.21.0)

The SnoozeService API is used to temporarily prevent an alert policy from generating alerts.

A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.

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

SnoozeServiceClient(SnoozeServiceClient const &)

Copy and move support

Parameter
NameDescription
SnoozeServiceClient const &

SnoozeServiceClient(SnoozeServiceClient &&)

Copy and move support

Parameter
NameDescription
SnoozeServiceClient &&

SnoozeServiceClient(std::shared_ptr< SnoozeServiceConnection >, Options)

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

Operators

operator=(SnoozeServiceClient const &)

Copy and move support

Parameter
NameDescription
SnoozeServiceClient const &
Returns
TypeDescription
SnoozeServiceClient &

operator=(SnoozeServiceClient &&)

Copy and move support

Parameter
NameDescription
SnoozeServiceClient &&
Returns
TypeDescription
SnoozeServiceClient &

Functions

CreateSnooze(std::string const &, google::monitoring::v3::Snooze const &, Options)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened.

The Snooze applies for a specific time interval.

Parameters
NameDescription
parent std::string const &

Required. The project in which a Snooze should be created. The format is:
projects/[PROJECT_ID_OR_NUMBER]

snooze google::monitoring::v3::Snooze const &

Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

opts Options

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

Returns
TypeDescription
StatusOr< google::monitoring::v3::Snooze >

the result of the RPC. The response message type (google.monitoring.v3.Snooze) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSnooze(google::monitoring::v3::CreateSnoozeRequest const &, Options)

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened.

The Snooze applies for a specific time interval.

Parameters
NameDescription
request google::monitoring::v3::CreateSnoozeRequest 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