#include <health_check.h>
An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
◆ HealthCheck() [1/2]
google_compute_api::HealthCheck::HealthCheck |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ HealthCheck() [2/2]
google_compute_api::HealthCheck::HealthCheck |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~HealthCheck()
google_compute_api::HealthCheck::~HealthCheck |
( |
| ) |
|
|
virtual |
◆ clear_check_interval_sec()
void google_compute_api::HealthCheck::clear_check_interval_sec |
( |
| ) |
|
|
inline |
Clears the 'checkIntervalSec
' attribute.
◆ clear_creation_timestamp()
void google_compute_api::HealthCheck::clear_creation_timestamp |
( |
| ) |
|
|
inline |
Clears the 'creationTimestamp
' attribute.
◆ clear_description()
void google_compute_api::HealthCheck::clear_description |
( |
| ) |
|
|
inline |
Clears the 'description
' attribute.
◆ clear_healthy_threshold()
void google_compute_api::HealthCheck::clear_healthy_threshold |
( |
| ) |
|
|
inline |
Clears the 'healthyThreshold
' attribute.
◆ clear_http2_health_check()
void google_compute_api::HealthCheck::clear_http2_health_check |
( |
| ) |
|
|
inline |
Clears the 'http2HealthCheck
' attribute.
◆ clear_http_health_check()
void google_compute_api::HealthCheck::clear_http_health_check |
( |
| ) |
|
|
inline |
Clears the 'httpHealthCheck
' attribute.
◆ clear_https_health_check()
void google_compute_api::HealthCheck::clear_https_health_check |
( |
| ) |
|
|
inline |
Clears the 'httpsHealthCheck
' attribute.
◆ clear_id()
void google_compute_api::HealthCheck::clear_id |
( |
| ) |
|
|
inline |
Clears the 'id
' attribute.
◆ clear_kind()
void google_compute_api::HealthCheck::clear_kind |
( |
| ) |
|
|
inline |
Clears the 'kind
' attribute.
◆ clear_name()
void google_compute_api::HealthCheck::clear_name |
( |
| ) |
|
|
inline |
Clears the 'name
' attribute.
◆ clear_self_link()
void google_compute_api::HealthCheck::clear_self_link |
( |
| ) |
|
|
inline |
Clears the 'selfLink
' attribute.
◆ clear_ssl_health_check()
void google_compute_api::HealthCheck::clear_ssl_health_check |
( |
| ) |
|
|
inline |
Clears the 'sslHealthCheck
' attribute.
◆ clear_tcp_health_check()
void google_compute_api::HealthCheck::clear_tcp_health_check |
( |
| ) |
|
|
inline |
Clears the 'tcpHealthCheck
' attribute.
◆ clear_timeout_sec()
void google_compute_api::HealthCheck::clear_timeout_sec |
( |
| ) |
|
|
inline |
Clears the 'timeoutSec
' attribute.
◆ clear_type()
void google_compute_api::HealthCheck::clear_type |
( |
| ) |
|
|
inline |
Clears the 'type
' attribute.
◆ clear_unhealthy_threshold()
void google_compute_api::HealthCheck::clear_unhealthy_threshold |
( |
| ) |
|
|
inline |
Clears the 'unhealthyThreshold
' attribute.
◆ get_check_interval_sec()
int32 google_compute_api::HealthCheck::get_check_interval_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'checkIntervalSec
' attribute.
◆ get_creation_timestamp()
const StringPiece google_compute_api::HealthCheck::get_creation_timestamp |
( |
| ) |
const |
|
inline |
Get the value of the 'creationTimestamp
' attribute.
◆ get_description()
const StringPiece google_compute_api::HealthCheck::get_description |
( |
| ) |
const |
|
inline |
Get the value of the 'description
' attribute.
◆ get_healthy_threshold()
int32 google_compute_api::HealthCheck::get_healthy_threshold |
( |
| ) |
const |
|
inline |
Get the value of the 'healthyThreshold
' attribute.
◆ get_http2_health_check()
const HTTP2HealthCheck google_compute_api::HealthCheck::get_http2_health_check |
( |
| ) |
const |
Get a reference to the value of the 'http2HealthCheck
' attribute.
◆ get_http_health_check()
const HTTPHealthCheck google_compute_api::HealthCheck::get_http_health_check |
( |
| ) |
const |
Get a reference to the value of the 'httpHealthCheck
' attribute.
◆ get_https_health_check()
const HTTPSHealthCheck google_compute_api::HealthCheck::get_https_health_check |
( |
| ) |
const |
Get a reference to the value of the 'httpsHealthCheck
' attribute.
◆ get_id()
uint64 google_compute_api::HealthCheck::get_id |
( |
| ) |
const |
|
inline |
Get the value of the 'id
' attribute.
◆ get_kind()
const StringPiece google_compute_api::HealthCheck::get_kind |
( |
| ) |
const |
|
inline |
Get the value of the 'kind
' attribute.
◆ get_name()
const StringPiece google_compute_api::HealthCheck::get_name |
( |
| ) |
const |
|
inline |
Get the value of the 'name
' attribute.
◆ get_self_link()
const StringPiece google_compute_api::HealthCheck::get_self_link |
( |
| ) |
const |
|
inline |
Get the value of the 'selfLink
' attribute.
◆ get_ssl_health_check()
const SSLHealthCheck google_compute_api::HealthCheck::get_ssl_health_check |
( |
| ) |
const |
Get a reference to the value of the 'sslHealthCheck
' attribute.
◆ get_tcp_health_check()
const TCPHealthCheck google_compute_api::HealthCheck::get_tcp_health_check |
( |
| ) |
const |
Get a reference to the value of the 'tcpHealthCheck
' attribute.
◆ get_timeout_sec()
int32 google_compute_api::HealthCheck::get_timeout_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'timeoutSec
' attribute.
◆ get_type()
const StringPiece google_compute_api::HealthCheck::get_type |
( |
| ) |
const |
|
inline |
Get the value of the 'type
' attribute.
◆ get_unhealthy_threshold()
int32 google_compute_api::HealthCheck::get_unhealthy_threshold |
( |
| ) |
const |
|
inline |
Get the value of the 'unhealthyThreshold
' attribute.
◆ GetTypeName()
const StringPiece google_compute_api::HealthCheck::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_check_interval_sec()
bool google_compute_api::HealthCheck::has_check_interval_sec |
( |
| ) |
const |
|
inline |
Determine if the 'checkIntervalSec
' attribute was set.
- Returns
- true if the '
checkIntervalSec
' attribute was set.
◆ has_creation_timestamp()
bool google_compute_api::HealthCheck::has_creation_timestamp |
( |
| ) |
const |
|
inline |
Determine if the 'creationTimestamp
' attribute was set.
- Returns
- true if the '
creationTimestamp
' attribute was set.
◆ has_description()
bool google_compute_api::HealthCheck::has_description |
( |
| ) |
const |
|
inline |
Determine if the 'description
' attribute was set.
- Returns
- true if the '
description
' attribute was set.
◆ has_healthy_threshold()
bool google_compute_api::HealthCheck::has_healthy_threshold |
( |
| ) |
const |
|
inline |
Determine if the 'healthyThreshold
' attribute was set.
- Returns
- true if the '
healthyThreshold
' attribute was set.
◆ has_http2_health_check()
bool google_compute_api::HealthCheck::has_http2_health_check |
( |
| ) |
const |
|
inline |
Determine if the 'http2HealthCheck
' attribute was set.
- Returns
- true if the '
http2HealthCheck
' attribute was set.
◆ has_http_health_check()
bool google_compute_api::HealthCheck::has_http_health_check |
( |
| ) |
const |
|
inline |
Determine if the 'httpHealthCheck
' attribute was set.
- Returns
- true if the '
httpHealthCheck
' attribute was set.
◆ has_https_health_check()
bool google_compute_api::HealthCheck::has_https_health_check |
( |
| ) |
const |
|
inline |
Determine if the 'httpsHealthCheck
' attribute was set.
- Returns
- true if the '
httpsHealthCheck
' attribute was set.
◆ has_id()
bool google_compute_api::HealthCheck::has_id |
( |
| ) |
const |
|
inline |
Determine if the 'id
' attribute was set.
- Returns
- true if the '
id
' attribute was set.
◆ has_kind()
bool google_compute_api::HealthCheck::has_kind |
( |
| ) |
const |
|
inline |
Determine if the 'kind
' attribute was set.
- Returns
- true if the '
kind
' attribute was set.
◆ has_name()
bool google_compute_api::HealthCheck::has_name |
( |
| ) |
const |
|
inline |
Determine if the 'name
' attribute was set.
- Returns
- true if the '
name
' attribute was set.
◆ has_self_link()
bool google_compute_api::HealthCheck::has_self_link |
( |
| ) |
const |
|
inline |
Determine if the 'selfLink
' attribute was set.
- Returns
- true if the '
selfLink
' attribute was set.
◆ has_ssl_health_check()
bool google_compute_api::HealthCheck::has_ssl_health_check |
( |
| ) |
const |
|
inline |
Determine if the 'sslHealthCheck
' attribute was set.
- Returns
- true if the '
sslHealthCheck
' attribute was set.
◆ has_tcp_health_check()
bool google_compute_api::HealthCheck::has_tcp_health_check |
( |
| ) |
const |
|
inline |
Determine if the 'tcpHealthCheck
' attribute was set.
- Returns
- true if the '
tcpHealthCheck
' attribute was set.
◆ has_timeout_sec()
bool google_compute_api::HealthCheck::has_timeout_sec |
( |
| ) |
const |
|
inline |
Determine if the 'timeoutSec
' attribute was set.
- Returns
- true if the '
timeoutSec
' attribute was set.
◆ has_type()
bool google_compute_api::HealthCheck::has_type |
( |
| ) |
const |
|
inline |
Determine if the 'type
' attribute was set.
- Returns
- true if the '
type
' attribute was set.
◆ has_unhealthy_threshold()
bool google_compute_api::HealthCheck::has_unhealthy_threshold |
( |
| ) |
const |
|
inline |
Determine if the 'unhealthyThreshold
' attribute was set.
- Returns
- true if the '
unhealthyThreshold
' attribute was set.
◆ mutable_http2HealthCheck()
Gets a reference to a mutable value of the 'http2HealthCheck
' property.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_httpHealthCheck()
HTTPHealthCheck google_compute_api::HealthCheck::mutable_httpHealthCheck |
( |
| ) |
|
Gets a reference to a mutable value of the 'httpHealthCheck
' property.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_httpsHealthCheck()
Gets a reference to a mutable value of the 'httpsHealthCheck
' property.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_sslHealthCheck()
SSLHealthCheck google_compute_api::HealthCheck::mutable_sslHealthCheck |
( |
| ) |
|
Gets a reference to a mutable value of the 'sslHealthCheck
' property.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_tcpHealthCheck()
TCPHealthCheck google_compute_api::HealthCheck::mutable_tcpHealthCheck |
( |
| ) |
|
Gets a reference to a mutable value of the 'tcpHealthCheck
' property.
- Returns
- The result can be modified to change the attribute value.
◆ New()
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_check_interval_sec()
void google_compute_api::HealthCheck::set_check_interval_sec |
( |
int32 |
value | ) |
|
|
inline |
Change the 'checkIntervalSec
' attribute.
How often (in seconds) to send a health check. The default value is 5 seconds.
- Parameters
-
◆ set_creation_timestamp()
void google_compute_api::HealthCheck::set_creation_timestamp |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'creationTimestamp
' attribute.
[Output Only] Creation timestamp in 3339 text format.
- Parameters
-
◆ set_description()
void google_compute_api::HealthCheck::set_description |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'description
' attribute.
An optional description of this resource. Provide this property when you create the resource.
- Parameters
-
◆ set_healthy_threshold()
void google_compute_api::HealthCheck::set_healthy_threshold |
( |
int32 |
value | ) |
|
|
inline |
Change the 'healthyThreshold
' attribute.
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
- Parameters
-
◆ set_id()
void google_compute_api::HealthCheck::set_id |
( |
uint64 |
value | ) |
|
|
inline |
Change the 'id
' attribute.
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
- Parameters
-
◆ set_kind()
void google_compute_api::HealthCheck::set_kind |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'kind
' attribute.
Type of the resource.
- Parameters
-
◆ set_name()
void google_compute_api::HealthCheck::set_name |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'name
' attribute.
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- Parameters
-
◆ set_self_link()
void google_compute_api::HealthCheck::set_self_link |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'selfLink
' attribute.
[Output Only] Server-defined URL for the resource.
- Parameters
-
◆ set_timeout_sec()
void google_compute_api::HealthCheck::set_timeout_sec |
( |
int32 |
value | ) |
|
|
inline |
Change the 'timeoutSec
' attribute.
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- Parameters
-
◆ set_type()
void google_compute_api::HealthCheck::set_type |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'type
' attribute.
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol- specific health check field must be specified, which must match type field.
- Parameters
-
◆ set_unhealthy_threshold()
void google_compute_api::HealthCheck::set_unhealthy_threshold |
( |
int32 |
value | ) |
|
|
inline |
Change the 'unhealthyThreshold
' attribute.
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
- Parameters
-
The documentation for this class was generated from the following files: