Class UptimeCheckServiceClient (2.15.1)

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Cloud Monitoring product.

An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Cloud Monitoring, and then clicking on "Uptime".

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

UptimeCheckServiceClient(UptimeCheckServiceClient const &)

Copy and move support

Parameter
Name Description
UptimeCheckServiceClient const &

UptimeCheckServiceClient(UptimeCheckServiceClient &&)

Copy and move support

Parameter
Name Description
UptimeCheckServiceClient &&

UptimeCheckServiceClient(std::shared_ptr< UptimeCheckServiceConnection >, Options)

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

Operators

operator=(UptimeCheckServiceClient const &)

Copy and move support

Parameter
Name Description
UptimeCheckServiceClient const &
Returns
Type Description
UptimeCheckServiceClient &

operator=(UptimeCheckServiceClient &&)

Copy and move support

Parameter
Name Description
UptimeCheckServiceClient &&
Returns
Type Description
UptimeCheckServiceClient &

Functions

ListUptimeCheckConfigs(std::string const &, Options)

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Parameters
Name Description
parent std::string const &

Required. The project whose Uptime check configurations are listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]

opts Options

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

Returns
Type Description
StreamRange< google::monitoring::v3::UptimeCheckConfig >

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

ListUptimeCheckConfigs(google::monitoring::v3::ListUptimeCheckConfigsRequest, Options)

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Parameters
Name Description
request google::monitoring::v3::ListUptimeCheckConfigsRequest

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.ListUptimeCheckConfigsRequest. Proto messages