Class HttpsHealthChecksClient (2.20.0)

Version 2.20.0

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

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.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/delete

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::DeleteHttpsHealthCheckRequest const &, Options)

Deletes the specified HttpsHealthCheck resource.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/delete

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.DeleteHttpsHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetHttpsHealthCheck(std::string const &, std::string const &, Options)

Returns the specified HttpsHealthCheck resource.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/get

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 StatusOr contains the error details.

GetHttpsHealthCheck(google::cloud::cpp::compute::https_health_checks::v1::GetHttpsHealthCheckRequest const &, Options)

Returns the specified HttpsHealthCheck resource.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/get

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.GetHttpsHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/insert

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/insert

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.InsertHttpsHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListHttpsHealthChecks(std::string const &, Options)

Retrieves the list of HttpsHealthCheck resources available to the specified project.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/list

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.HttpsHealthCheck, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListHttpsHealthChecks(google::cloud::cpp::compute::https_health_checks::v1::ListHttpsHealthChecksRequest, Options)

Retrieves the list of HttpsHealthCheck resources available to the specified project.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/list

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.ListHttpsHealthChecksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.HttpsHealthCheck, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.PatchHttpsHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/update

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/httpsHealthChecks/update

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.https_health_checks.v1.UpdateHttpsHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.