Service for the regionHealthCheckServices resource.
https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthCheckServices
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
RegionHealthCheckServicesClient(RegionHealthCheckServicesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthCheckServicesClient const &
|
RegionHealthCheckServicesClient(RegionHealthCheckServicesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthCheckServicesClient &&
|
RegionHealthCheckServicesClient(std::shared_ptr< RegionHealthCheckServicesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< RegionHealthCheckServicesConnection >
|
opts |
Options
|
Operators
operator=(RegionHealthCheckServicesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthCheckServicesClient const &
|
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient & |
operator=(RegionHealthCheckServicesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionHealthCheckServicesClient &&
|
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient & |
Functions
DeleteHealthCheckService(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified regional HealthCheckService.
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_service |
std::string const &
Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. |
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 |
DeleteHealthCheckService(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified regional HealthCheckService.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
health_check_service |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHealthCheckService(google::cloud::cpp::compute::region_health_check_services::v1::DeleteHealthCheckServiceRequest const &, Options)
Deletes the specified regional HealthCheckService.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_check_services::v1::DeleteHealthCheckServiceRequest 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 |
DeleteHealthCheckService(NoAwaitTag, google::cloud::cpp::compute::region_health_check_services::v1::DeleteHealthCheckServiceRequest const &, Options)
Deletes the specified regional HealthCheckService.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::region_health_check_services::v1::DeleteHealthCheckServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHealthCheckService(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified regional HealthCheckService.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetHealthCheckService(std::string const &, std::string const &, std::string const &, Options)
Returns the specified regional HealthCheckService 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_service |
std::string const &
Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::HealthCheckService > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthCheckService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHealthCheckService(google::cloud::cpp::compute::region_health_check_services::v1::GetHealthCheckServiceRequest const &, Options)
Returns the specified regional HealthCheckService resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_check_services::v1::GetHealthCheckServiceRequest 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::HealthCheckService > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HealthCheckService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertHealthCheckService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheckService const &, Options)
Creates a regional HealthCheckService resource in the specified project and region 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_service_resource |
google::cloud::cpp::compute::v1::HealthCheckService const &
The HealthCheckService 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 |
InsertHealthCheckService(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheckService const &, Options)
Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
health_check_service_resource |
google::cloud::cpp::compute::v1::HealthCheckService const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHealthCheckService(google::cloud::cpp::compute::region_health_check_services::v1::InsertHealthCheckServiceRequest const &, Options)
Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_check_services::v1::InsertHealthCheckServiceRequest 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 |
InsertHealthCheckService(NoAwaitTag, google::cloud::cpp::compute::region_health_check_services::v1::InsertHealthCheckServiceRequest const &, Options)
Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::region_health_check_services::v1::InsertHealthCheckServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHealthCheckService(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListRegionHealthCheckServices(std::string const &, std::string const &, Options)
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
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::HealthCheckService > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRegionHealthCheckServices(google::cloud::cpp::compute::region_health_check_services::v1::ListRegionHealthCheckServicesRequest, Options)
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_check_services::v1::ListRegionHealthCheckServicesRequest
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::HealthCheckService > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchHealthCheckService(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheckService const &, Options)
Updates the specified regional HealthCheckService resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthCheckServices/patch
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_service |
std::string const &
Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. |
health_check_service_resource |
google::cloud::cpp::compute::v1::HealthCheckService const &
The HealthCheckService 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 |
PatchHealthCheckService(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HealthCheckService const &, Options)
Updates the specified regional HealthCheckService resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
health_check_service |
std::string const &
|
health_check_service_resource |
google::cloud::cpp::compute::v1::HealthCheckService const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHealthCheckService(google::cloud::cpp::compute::region_health_check_services::v1::PatchHealthCheckServiceRequest const &, Options)
Updates the specified regional HealthCheckService resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthCheckServices/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_health_check_services::v1::PatchHealthCheckServiceRequest 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 |
PatchHealthCheckService(NoAwaitTag, google::cloud::cpp::compute::region_health_check_services::v1::PatchHealthCheckServiceRequest const &, Options)
Updates the specified regional HealthCheckService resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::region_health_check_services::v1::PatchHealthCheckServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHealthCheckService(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified regional HealthCheckService resource with the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |