Class UptimeCheckServiceClient (2.23.0-rc)

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 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::monitoring::v3::UptimeCheckConfig >

GetUptimeCheckConfig(std::string const &, Options)

Gets a single Uptime check configuration.

Parameters
Name	Description
`name`	`std::string const &` Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetUptimeCheckConfig(google::monitoring::v3::GetUptimeCheckConfigRequest const &, Options)

Gets a single Uptime check configuration.

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

CreateUptimeCheckConfig(std::string const &, google::monitoring::v3::UptimeCheckConfig const &, Options)

Creates a new Uptime check configuration.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]
`uptime_check_config`	`google::monitoring::v3::UptimeCheckConfig const &` Required. The new Uptime check configuration.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CreateUptimeCheckConfig(google::monitoring::v3::CreateUptimeCheckConfigRequest const &, Options)

Creates a new Uptime check configuration.

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

UpdateUptimeCheckConfig(google::monitoring::v3::UptimeCheckConfig const &, Options)

Updates an Uptime check configuration.

You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.

Parameters
Name	Description
`uptime_check_config`	`google::monitoring::v3::UptimeCheckConfig const &` Required. If an `updateMask` has been specified, this field gives the values for the set of fields mentioned in the `updateMask`. If an `updateMask` has not been given, this Uptime check configuration replaces the current configuration. If a field is mentioned in `updateMask` but the corresponding field is omitted in this partial Uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. The following fields can be updated: `display_name`, `http_check`, `tcp_check`, `timeout`, `content_matchers`, and `selected_regions`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateUptimeCheckConfig(google::monitoring::v3::UpdateUptimeCheckConfigRequest const &, Options)

Updates an Uptime check configuration.

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

DeleteUptimeCheckConfig(std::string const &, Options)

Deletes an Uptime check configuration.

Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Parameters
Name	Description
`name`	`std::string const &` Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteUptimeCheckConfig(google::monitoring::v3::DeleteUptimeCheckConfigRequest const &, Options)

Deletes an Uptime check configuration.

Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Parameters
Name	Description
`request`	`google::monitoring::v3::DeleteUptimeCheckConfigRequest 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.monitoring.v3.DeleteUptimeCheckConfigRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListUptimeCheckIps(google::monitoring::v3::ListUptimeCheckIpsRequest, Options)

Returns the list of IP addresses that checkers run from.

Parameters
Name	Description
`request`	`google::monitoring::v3::ListUptimeCheckIpsRequest` 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.ListUptimeCheckIpsRequest. 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::monitoring::v3::UptimeCheckIp >

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