#include <http_health_check.h>
An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
◆ HttpHealthCheck() [1/2]
google_compute_api::HttpHealthCheck::HttpHealthCheck |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ HttpHealthCheck() [2/2]
google_compute_api::HttpHealthCheck::HttpHealthCheck |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~HttpHealthCheck()
google_compute_api::HttpHealthCheck::~HttpHealthCheck |
( |
| ) |
|
|
virtual |
◆ clear_check_interval_sec()
void google_compute_api::HttpHealthCheck::clear_check_interval_sec |
( |
| ) |
|
|
inline |
Clears the 'checkIntervalSec
' attribute.
◆ clear_creation_timestamp()
void google_compute_api::HttpHealthCheck::clear_creation_timestamp |
( |
| ) |
|
|
inline |
Clears the 'creationTimestamp
' attribute.
◆ clear_description()
void google_compute_api::HttpHealthCheck::clear_description |
( |
| ) |
|
|
inline |
Clears the 'description
' attribute.
◆ clear_healthy_threshold()
void google_compute_api::HttpHealthCheck::clear_healthy_threshold |
( |
| ) |
|
|
inline |
Clears the 'healthyThreshold
' attribute.
◆ clear_host()
void google_compute_api::HttpHealthCheck::clear_host |
( |
| ) |
|
|
inline |
Clears the 'host
' attribute.
◆ clear_id()
void google_compute_api::HttpHealthCheck::clear_id |
( |
| ) |
|
|
inline |
Clears the 'id
' attribute.
◆ clear_kind()
void google_compute_api::HttpHealthCheck::clear_kind |
( |
| ) |
|
|
inline |
Clears the 'kind
' attribute.
◆ clear_name()
void google_compute_api::HttpHealthCheck::clear_name |
( |
| ) |
|
|
inline |
Clears the 'name
' attribute.
◆ clear_port()
void google_compute_api::HttpHealthCheck::clear_port |
( |
| ) |
|
|
inline |
Clears the 'port
' attribute.
◆ clear_request_path()
void google_compute_api::HttpHealthCheck::clear_request_path |
( |
| ) |
|
|
inline |
Clears the 'requestPath
' attribute.
◆ clear_self_link()
void google_compute_api::HttpHealthCheck::clear_self_link |
( |
| ) |
|
|
inline |
Clears the 'selfLink
' attribute.
◆ clear_timeout_sec()
void google_compute_api::HttpHealthCheck::clear_timeout_sec |
( |
| ) |
|
|
inline |
Clears the 'timeoutSec
' attribute.
◆ clear_unhealthy_threshold()
void google_compute_api::HttpHealthCheck::clear_unhealthy_threshold |
( |
| ) |
|
|
inline |
Clears the 'unhealthyThreshold
' attribute.
◆ get_check_interval_sec()
int32 google_compute_api::HttpHealthCheck::get_check_interval_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'checkIntervalSec
' attribute.
◆ get_creation_timestamp()
const StringPiece google_compute_api::HttpHealthCheck::get_creation_timestamp |
( |
| ) |
const |
|
inline |
Get the value of the 'creationTimestamp
' attribute.
◆ get_description()
const StringPiece google_compute_api::HttpHealthCheck::get_description |
( |
| ) |
const |
|
inline |
Get the value of the 'description
' attribute.
◆ get_healthy_threshold()
int32 google_compute_api::HttpHealthCheck::get_healthy_threshold |
( |
| ) |
const |
|
inline |
Get the value of the 'healthyThreshold
' attribute.
◆ get_host()
const StringPiece google_compute_api::HttpHealthCheck::get_host |
( |
| ) |
const |
|
inline |
Get the value of the 'host
' attribute.
◆ get_id()
uint64 google_compute_api::HttpHealthCheck::get_id |
( |
| ) |
const |
|
inline |
Get the value of the 'id
' attribute.
◆ get_kind()
const StringPiece google_compute_api::HttpHealthCheck::get_kind |
( |
| ) |
const |
|
inline |
Get the value of the 'kind
' attribute.
◆ get_name()
const StringPiece google_compute_api::HttpHealthCheck::get_name |
( |
| ) |
const |
|
inline |
Get the value of the 'name
' attribute.
◆ get_port()
int32 google_compute_api::HttpHealthCheck::get_port |
( |
| ) |
const |
|
inline |
Get the value of the 'port
' attribute.
◆ get_request_path()
const StringPiece google_compute_api::HttpHealthCheck::get_request_path |
( |
| ) |
const |
|
inline |
Get the value of the 'requestPath
' attribute.
◆ get_self_link()
const StringPiece google_compute_api::HttpHealthCheck::get_self_link |
( |
| ) |
const |
|
inline |
Get the value of the 'selfLink
' attribute.
◆ get_timeout_sec()
int32 google_compute_api::HttpHealthCheck::get_timeout_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'timeoutSec
' attribute.
◆ get_unhealthy_threshold()
int32 google_compute_api::HttpHealthCheck::get_unhealthy_threshold |
( |
| ) |
const |
|
inline |
Get the value of the 'unhealthyThreshold
' attribute.
◆ GetTypeName()
const StringPiece google_compute_api::HttpHealthCheck::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_check_interval_sec()
bool google_compute_api::HttpHealthCheck::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::HttpHealthCheck::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::HttpHealthCheck::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::HttpHealthCheck::has_healthy_threshold |
( |
| ) |
const |
|
inline |
Determine if the 'healthyThreshold
' attribute was set.
- Returns
- true if the '
healthyThreshold
' attribute was set.
◆ has_host()
bool google_compute_api::HttpHealthCheck::has_host |
( |
| ) |
const |
|
inline |
Determine if the 'host
' attribute was set.
- Returns
- true if the '
host
' attribute was set.
◆ has_id()
bool google_compute_api::HttpHealthCheck::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::HttpHealthCheck::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::HttpHealthCheck::has_name |
( |
| ) |
const |
|
inline |
Determine if the 'name
' attribute was set.
- Returns
- true if the '
name
' attribute was set.
◆ has_port()
bool google_compute_api::HttpHealthCheck::has_port |
( |
| ) |
const |
|
inline |
Determine if the 'port
' attribute was set.
- Returns
- true if the '
port
' attribute was set.
◆ has_request_path()
bool google_compute_api::HttpHealthCheck::has_request_path |
( |
| ) |
const |
|
inline |
Determine if the 'requestPath
' attribute was set.
- Returns
- true if the '
requestPath
' attribute was set.
◆ has_self_link()
bool google_compute_api::HttpHealthCheck::has_self_link |
( |
| ) |
const |
|
inline |
Determine if the 'selfLink
' attribute was set.
- Returns
- true if the '
selfLink
' attribute was set.
◆ has_timeout_sec()
bool google_compute_api::HttpHealthCheck::has_timeout_sec |
( |
| ) |
const |
|
inline |
Determine if the 'timeoutSec
' attribute was set.
- Returns
- true if the '
timeoutSec
' attribute was set.
◆ has_unhealthy_threshold()
bool google_compute_api::HttpHealthCheck::has_unhealthy_threshold |
( |
| ) |
const |
|
inline |
Determine if the 'unhealthyThreshold
' attribute was set.
- Returns
- true if the '
unhealthyThreshold
' attribute was set.
◆ New()
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_check_interval_sec()
void google_compute_api::HttpHealthCheck::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::HttpHealthCheck::set_creation_timestamp |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'creationTimestamp
' attribute.
[Output Only] Creation timestamp in RFC3339 text format.
- Parameters
-
◆ set_description()
void google_compute_api::HttpHealthCheck::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::HttpHealthCheck::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_host()
void google_compute_api::HttpHealthCheck::set_host |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'host
' attribute.
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
- Parameters
-
◆ set_id()
void google_compute_api::HttpHealthCheck::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::HttpHealthCheck::set_kind |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'kind
' attribute.
[Output Only] Type of the resource. Always compute::httpHealthCheck for HTTP health checks.
- Parameters
-
◆ set_name()
void google_compute_api::HttpHealthCheck::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_port()
void google_compute_api::HttpHealthCheck::set_port |
( |
int32 |
value | ) |
|
|
inline |
Change the 'port
' attribute.
The TCP port number for the HTTP health check request. The default value is 80.
- Parameters
-
◆ set_request_path()
void google_compute_api::HttpHealthCheck::set_request_path |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'requestPath
' attribute.
The request path of the HTTP health check request. The default value is /.
- Parameters
-
◆ set_self_link()
void google_compute_api::HttpHealthCheck::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::HttpHealthCheck::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_unhealthy_threshold()
void google_compute_api::HttpHealthCheck::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: