Service for the httpsHealthChecks resource.
https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks
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
HttpsHealthChecksClient(HttpsHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpsHealthChecksClient const &
|
HttpsHealthChecksClient(HttpsHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpsHealthChecksClient &&
|
HttpsHealthChecksClient(std::shared_ptr< HttpsHealthChecksConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< HttpsHealthChecksConnection >
|
opts |
Options
|
Operators
operator=(HttpsHealthChecksClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpsHealthChecksClient const &
|
Returns | |
---|---|
Type | Description |
HttpsHealthChecksClient & |
operator=(HttpsHealthChecksClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
HttpsHealthChecksClient &&
|
Returns | |
---|---|
Type | Description |
HttpsHealthChecksClient & |
Functions
DeleteHttpsHealthCheck(std::string const &, std::string const &, Options)
Deletes the specified HttpsHealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
https_health_check |
std::string const &
Name of the HttpsHealthCheck 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 |
DeleteHttpsHealthCheck(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified HttpsHealthCheck 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 &
|
https_health_check |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::DeleteHttpsHealthCheckRequest const &, Options)
Deletes the specified HttpsHealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::DeleteHttpsHealthCheckRequest 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 |
DeleteHttpsHealthCheck(NoAwaitTag, google::cloud::cpp::compute::https_health_checks::v1::DeleteHttpsHealthCheckRequest const &, Options)
Deletes the specified HttpsHealthCheck 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::https_health_checks::v1::DeleteHttpsHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteHttpsHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified HttpsHealthCheck 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 > > |
GetHttpsHealthCheck(std::string const &, std::string const &, Options)
Returns the specified HttpsHealthCheck resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
https_health_check |
std::string const &
Name of the HttpsHealthCheck 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::HttpsHealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HttpsHealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::GetHttpsHealthCheckRequest const &, Options)
Returns the specified HttpsHealthCheck resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::GetHttpsHealthCheckRequest 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::HttpsHealthCheck > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.HttpsHealthCheck) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertHttpsHealthCheck(std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
The HttpsHealthCheck 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 |
InsertHttpsHealthCheck(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Creates a HttpsHealthCheck 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 &
|
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::InsertHttpsHealthCheckRequest const &, Options)
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::InsertHttpsHealthCheckRequest 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 |
InsertHttpsHealthCheck(NoAwaitTag, google::cloud::cpp::compute::https_health_checks::v1::InsertHttpsHealthCheckRequest const &, Options)
Creates a HttpsHealthCheck 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::https_health_checks::v1::InsertHttpsHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertHttpsHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a HttpsHealthCheck 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 > > |
ListHttpsHealthChecks(std::string const &, Options)
Retrieves the list of HttpsHealthCheck 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::HttpsHealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListHttpsHealthChecks(google::cloud::cpp::compute::https_health_checks::v1::ListHttpsHealthChecksRequest, Options)
Retrieves the list of HttpsHealthCheck resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::ListHttpsHealthChecksRequest
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::HttpsHealthCheck > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchHttpsHealthCheck(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Updates a HttpsHealthCheck 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/httpsHealthChecks/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
https_health_check |
std::string const &
Name of the HttpsHealthCheck resource to patch. |
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
The HttpsHealthCheck 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 |
PatchHttpsHealthCheck(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Updates a HttpsHealthCheck 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 &
|
https_health_check |
std::string const &
|
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::PatchHttpsHealthCheckRequest const &, Options)
Updates a HttpsHealthCheck 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/httpsHealthChecks/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::PatchHttpsHealthCheckRequest 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 |
PatchHttpsHealthCheck(NoAwaitTag, google::cloud::cpp::compute::https_health_checks::v1::PatchHttpsHealthCheckRequest const &, Options)
Updates a HttpsHealthCheck 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::https_health_checks::v1::PatchHttpsHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchHttpsHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates a HttpsHealthCheck 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 > > |
UpdateHttpsHealthCheck(std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
https_health_check |
std::string const &
Name of the HttpsHealthCheck resource to update. |
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
The HttpsHealthCheck 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 |
UpdateHttpsHealthCheck(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::HttpsHealthCheck const &, Options)
Updates a HttpsHealthCheck 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 &
|
https_health_check |
std::string const &
|
https_health_check_resource |
google::cloud::cpp::compute::v1::HttpsHealthCheck const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::UpdateHttpsHealthCheckRequest const &, Options)
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::https_health_checks::v1::UpdateHttpsHealthCheckRequest 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 |
UpdateHttpsHealthCheck(NoAwaitTag, google::cloud::cpp::compute::https_health_checks::v1::UpdateHttpsHealthCheckRequest const &, Options)
Updates a HttpsHealthCheck 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::https_health_checks::v1::UpdateHttpsHealthCheckRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateHttpsHealthCheck(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates a HttpsHealthCheck 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 > > |