Service for the healthChecks resource.
https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
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
HealthChecksClient(HealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HealthChecksClient const &
|
HealthChecksClient(HealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HealthChecksClient &&
|
HealthChecksClient(ExperimentalTag, std::shared_ptr< HealthChecksConnection >, Options)
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
connection |
std::shared_ptr< HealthChecksConnection >
|
opts |
Options
|
Operators
operator=(HealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HealthChecksClient const &
|
Returns | |
---|---|
Type | Description |
HealthChecksClient & |
operator=(HealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HealthChecksClient &&
|
Returns | |
---|---|
Type | Description |
HealthChecksClient & |
Functions
AggregatedListHealthChecks(std::string const &, Options)
Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Name of the project scoping this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::HealthChecksAggregatedList > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthChecksAggregatedList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AggregatedListHealthChecks(google::cloud::cpp::compute::health_checks::v1::AggregatedListHealthChecksRequest const &, Options)
Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::AggregatedListHealthChecksRequest 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::cloud::cpp::compute::v1::HealthChecksAggregatedList > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthChecksAggregatedList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteHealthChecks(std::string const &, std::string const &, Options)
Deletes the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
health_check |
std::string const &
Name of the HealthCheck resource to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteHealthChecks(google::cloud::cpp::compute::health_checks::v1::DeleteHealthChecksRequest const &, Options)
Deletes the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::DeleteHealthChecksRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
GetHealthChecks(std::string const &, std::string const &, Options)
Returns the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
health_check |
std::string const &
Name of the HealthCheck resource to return. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::HealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHealthChecks(google::cloud::cpp::compute::health_checks::v1::GetHealthChecksRequest const &, Options)
Returns the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::GetHealthChecksRequest 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::cloud::cpp::compute::v1::HealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertHealthChecks(std::string const &, google::cloud::cpp::compute::v1::HealthCheck const &, Options)
Creates a HealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
health_check_resource |
google::cloud::cpp::compute::v1::HealthCheck const &
The HealthCheck for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertHealthChecks(google::cloud::cpp::compute::health_checks::v1::InsertHealthChecksRequest const &, Options)
Creates a HealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::InsertHealthChecksRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
ListHealthChecks(std::string const &, Options)
Retrieves the list of HealthCheck resources available to the specified project.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::HealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListHealthChecks(google::cloud::cpp::compute::health_checks::v1::ListHealthChecksRequest, Options)
Retrieves the list of HealthCheck resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::ListHealthChecksRequest
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::cloud::cpp::compute::v1::HealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchHealthChecks(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheck const &, Options)
Updates a HealthCheck resource in the specified project using the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
health_check |
std::string const &
Name of the HealthCheck resource to patch. |
health_check_resource |
google::cloud::cpp::compute::v1::HealthCheck const &
The HealthCheck for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
PatchHealthChecks(google::cloud::cpp::compute::health_checks::v1::PatchHealthChecksRequest const &, Options)
Updates a HealthCheck resource in the specified project using the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::PatchHealthChecksRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateHealthChecks(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheck const &, Options)
Updates a HealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
health_check |
std::string const &
Name of the HealthCheck resource to update. |
health_check_resource |
google::cloud::cpp::compute::v1::HealthCheck const &
The HealthCheck for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateHealthChecks(google::cloud::cpp::compute::health_checks::v1::UpdateHealthChecksRequest const &, Options)
Updates a HealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::health_checks::v1::UpdateHealthChecksRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |