Service for the httpHealthChecks resource.
https://cloud.google.com/compute/docs/reference/rest/v1/httpHealthChecks
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
HttpHealthChecksClient(HttpHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpHealthChecksClient const &
|
HttpHealthChecksClient(HttpHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpHealthChecksClient &&
|
HttpHealthChecksClient(std::shared_ptr< HttpHealthChecksConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< HttpHealthChecksConnection >
|
opts |
Options
|
Operators
operator=(HttpHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpHealthChecksClient const &
|
Returns | |
---|---|
Type | Description |
HttpHealthChecksClient & |
operator=(HttpHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpHealthChecksClient &&
|
Returns | |
---|---|
Type | Description |
HttpHealthChecksClient & |
Functions
DeleteHttpHealthCheck(std::string const &, std::string const &, Options)
Deletes the specified HttpHealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
http_health_check |
std::string const &
Name of the HttpHealthCheck 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 |
DeleteHttpHealthCheck(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified HttpHealthCheck resource.
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 &
|
http_health_check |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHttpHealthCheck(google::cloud::cpp::compute::http_health_checks::v1::DeleteHttpHealthCheckRequest const &, Options)
Deletes the specified HttpHealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::DeleteHttpHealthCheckRequest 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 |
DeleteHttpHealthCheck(NoAwaitTag, google::cloud::cpp::compute::http_health_checks::v1::DeleteHttpHealthCheckRequest const &, Options)
Deletes the specified HttpHealthCheck resource.
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::http_health_checks::v1::DeleteHttpHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHttpHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified HttpHealthCheck resource.
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 > > |
GetHttpHealthCheck(std::string const &, std::string const &, Options)
Returns the specified HttpHealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
http_health_check |
std::string const &
Name of the HttpHealthCheck 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::HttpHealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HttpHealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHttpHealthCheck(google::cloud::cpp::compute::http_health_checks::v1::GetHttpHealthCheckRequest const &, Options)
Returns the specified HttpHealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::GetHttpHealthCheckRequest 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::HttpHealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HttpHealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertHttpHealthCheck(std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Creates a HttpHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
The HttpHealthCheck 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 |
InsertHttpHealthCheck(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Creates a HttpHealthCheck resource in the specified project 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 &
|
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHttpHealthCheck(google::cloud::cpp::compute::http_health_checks::v1::InsertHttpHealthCheckRequest const &, Options)
Creates a HttpHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::InsertHttpHealthCheckRequest 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 |
InsertHttpHealthCheck(NoAwaitTag, google::cloud::cpp::compute::http_health_checks::v1::InsertHttpHealthCheckRequest const &, Options)
Creates a HttpHealthCheck resource in the specified project 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::http_health_checks::v1::InsertHttpHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHttpHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a HttpHealthCheck resource in the specified project 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 > > |
ListHttpHealthChecks(std::string const &, Options)
Retrieves the list of HttpHealthCheck 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::HttpHealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListHttpHealthChecks(google::cloud::cpp::compute::http_health_checks::v1::ListHttpHealthChecksRequest, Options)
Retrieves the list of HttpHealthCheck resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::ListHttpHealthChecksRequest
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::HttpHealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchHttpHealthCheck(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Updates a HttpHealthCheck 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. https://cloud.google.com/compute/docs/reference/rest/v1/httpHealthChecks/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
http_health_check |
std::string const &
Name of the HttpHealthCheck resource to patch. |
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
The HttpHealthCheck 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 |
PatchHttpHealthCheck(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Updates a HttpHealthCheck resource in the specified project 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 &
|
http_health_check |
std::string const &
|
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHttpHealthCheck(google::cloud::cpp::compute::http_health_checks::v1::PatchHttpHealthCheckRequest const &, Options)
Updates a HttpHealthCheck 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. https://cloud.google.com/compute/docs/reference/rest/v1/httpHealthChecks/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::PatchHttpHealthCheckRequest 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 |
PatchHttpHealthCheck(NoAwaitTag, google::cloud::cpp::compute::http_health_checks::v1::PatchHttpHealthCheckRequest const &, Options)
Updates a HttpHealthCheck resource in the specified project 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::http_health_checks::v1::PatchHttpHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHttpHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates a HttpHealthCheck resource in the specified project 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 > > |
UpdateHttpHealthCheck(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Updates a HttpHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
http_health_check |
std::string const &
Name of the HttpHealthCheck resource to update. |
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
The HttpHealthCheck 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 |
UpdateHttpHealthCheck(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpHealthCheck const &, Options)
Updates a HttpHealthCheck resource in the specified project 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 &
|
http_health_check |
std::string const &
|
http_health_check_resource |
google::cloud::cpp::compute::v1::HttpHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateHttpHealthCheck(google::cloud::cpp::compute::http_health_checks::v1::UpdateHttpHealthCheckRequest const &, Options)
Updates a HttpHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::http_health_checks::v1::UpdateHttpHealthCheckRequest 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 |
UpdateHttpHealthCheck(NoAwaitTag, google::cloud::cpp::compute::http_health_checks::v1::UpdateHttpHealthCheckRequest const &, Options)
Updates a HttpHealthCheck resource in the specified project 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::http_health_checks::v1::UpdateHttpHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateHttpHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates a HttpHealthCheck resource in the specified project 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 > > |