Service for the regionHealthChecks resource.
https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthChecks
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
RegionHealthChecksClient(RegionHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthChecksClient const &
|
RegionHealthChecksClient(RegionHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthChecksClient &&
|
RegionHealthChecksClient(ExperimentalTag, std::shared_ptr< RegionHealthChecksConnection >, Options)
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
connection |
std::shared_ptr< RegionHealthChecksConnection >
|
opts |
Options
|
Operators
operator=(RegionHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthChecksClient const &
|
Returns | |
---|---|
Type | Description |
RegionHealthChecksClient & |
operator=(RegionHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthChecksClient &&
|
Returns | |
---|---|
Type | Description |
RegionHealthChecksClient & |
Functions
DeleteRegionHealthChecks(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
DeleteRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::DeleteRegionHealthChecksRequest const &, Options)
Deletes the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_checks::v1::DeleteRegionHealthChecksRequest 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 |
GetRegionHealthChecks(std::string const &, std::string const &, std::string const &, Options)
Returns the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
GetRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::GetRegionHealthChecksRequest const &, Options)
Returns the specified HealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_checks::v1::GetRegionHealthChecksRequest 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 |
InsertRegionHealthChecks(std::string const &, 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. |
region |
std::string const &
Name of the region scoping 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 |
InsertRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::InsertRegionHealthChecksRequest 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::region_health_checks::v1::InsertRegionHealthChecksRequest 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 |
ListRegionHealthChecks(std::string const &, 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. |
region |
std::string const &
Name of the region scoping 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 |
ListRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::ListRegionHealthChecksRequest, Options)
Retrieves the list of HealthCheck resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_checks::v1::ListRegionHealthChecksRequest
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 |
PatchRegionHealthChecks(std::string const &, 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. |
region |
std::string const &
Name of the region scoping 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 |
PatchRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::PatchRegionHealthChecksRequest 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::region_health_checks::v1::PatchRegionHealthChecksRequest 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 |
UpdateRegionHealthChecks(std::string const &, 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. |
region |
std::string const &
Name of the region scoping 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 |
UpdateRegionHealthChecks(google::cloud::cpp::compute::region_health_checks::v1::UpdateRegionHealthChecksRequest 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::region_health_checks::v1::UpdateRegionHealthChecksRequest 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 |