Class AlertPolicyServiceClient (2.17.0)

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Cloud Monitoring.

An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Cloud Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud console.

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

AlertPolicyServiceClient(AlertPolicyServiceClient const &)

Copy and move support

Parameter
NameDescription
AlertPolicyServiceClient const &

AlertPolicyServiceClient(AlertPolicyServiceClient &&)

Copy and move support

Parameter
NameDescription
AlertPolicyServiceClient &&

AlertPolicyServiceClient(std::shared_ptr< AlertPolicyServiceConnection >, Options)

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

Operators

operator=(AlertPolicyServiceClient const &)

Copy and move support

Parameter
NameDescription
AlertPolicyServiceClient const &
Returns
TypeDescription
AlertPolicyServiceClient &

operator=(AlertPolicyServiceClient &&)

Copy and move support

Parameter
NameDescription
AlertPolicyServiceClient &&
Returns
TypeDescription
AlertPolicyServiceClient &

Functions

ListAlertPolicies(std::string const &, Options)

Lists the existing alerting policies for the workspace.

Parameters
NameDescription
name std::string const &

Required. The project whose alert policies are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.

opts Options

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

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

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

ListAlertPolicies(google::monitoring::v3::ListAlertPoliciesRequest, Options)

Lists the existing alerting policies for the workspace.

Parameters
NameDescription
request google::monitoring::v3::ListAlertPoliciesRequest

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.monitoring.v3.ListAlertPoliciesRequest. 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
TypeDescription
St