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 | |
---|---|
Name | Description |
|
SnoozeServiceClient const &
|
SnoozeServiceClient(SnoozeServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SnoozeServiceClient &&
|
SnoozeServiceClient(std::shared_ptr< SnoozeServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SnoozeServiceConnection >
|
opts |
Options
|
Operators
operator=(SnoozeServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SnoozeServiceClient const &
|
Returns | |
---|---|
Type | Description |
SnoozeServiceClient & |
operator=(SnoozeServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SnoozeServiceClient &&
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project in which a |
snooze |
google::monitoring::v3::Snooze const &
Required. The |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
request |
google::monitoring::v3::CreateSnoozeRequest 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::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 |
ListSnoozes(std::string const &, Options)
Lists the Snooze
s associated with a project.
Can optionally pass in filter
, which specifies predicates to match Snooze
s.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project whose |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::monitoring::v3::Snooze > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSnoozes(google::monitoring::v3::ListSnoozesRequest, Options)
Lists the Snooze
s associated with a project.
Can optionally pass in filter
, which specifies predicates to match Snooze
s.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::v3::ListSnoozesRequest
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::monitoring::v3::Snooze > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetSnooze(std::string const &, Options)
Retrieves a Snooze
by name
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The ID of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
GetSnooze(google::monitoring::v3::GetSnoozeRequest const &, Options)
Retrieves a Snooze
by name
.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::v3::GetSnoozeRequest 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::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 |
UpdateSnooze(google::monitoring::v3::Snooze const &, google::protobuf::FieldMask const &, Options)
Updates a Snooze
, identified by its name
, with the parameters in the given Snooze
object.
Parameters | |
---|---|
Name | Description |
snooze |
google::monitoring::v3::Snooze const &
Required. The |
update_mask |
google::protobuf::FieldMask const &
Required. The fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
UpdateSnooze(google::monitoring::v3::UpdateSnoozeRequest const &, Options)
Updates a Snooze
, identified by its name
, with the parameters in the given Snooze
object.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::v3::UpdateSnoozeRequest 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::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 |