#include <backend_service.h>
A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==).
◆ BackendService() [1/2]
google_compute_api::BackendService::BackendService |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ BackendService() [2/2]
google_compute_api::BackendService::BackendService |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~BackendService()
google_compute_api::BackendService::~BackendService |
( |
| ) |
|
|
virtual |
◆ clear_affinity_cookie_ttl_sec()
void google_compute_api::BackendService::clear_affinity_cookie_ttl_sec |
( |
| ) |
|
|
inline |
Clears the 'affinityCookieTtlSec
' attribute.
◆ clear_backends()
void google_compute_api::BackendService::clear_backends |
( |
| ) |
|
|
inline |
Clears the 'backends
' attribute.
◆ clear_cdn_policy()
void google_compute_api::BackendService::clear_cdn_policy |
( |
| ) |
|
|
inline |
Clears the 'cdnPolicy
' attribute.
◆ clear_connection_draining()
void google_compute_api::BackendService::clear_connection_draining |
( |
| ) |
|
|
inline |
Clears the 'connectionDraining
' attribute.
◆ clear_creation_timestamp()
void google_compute_api::BackendService::clear_creation_timestamp |
( |
| ) |
|
|
inline |
Clears the 'creationTimestamp
' attribute.
◆ clear_custom_request_headers()
void google_compute_api::BackendService::clear_custom_request_headers |
( |
| ) |
|
|
inline |
Clears the 'customRequestHeaders
' attribute.
◆ clear_description()
void google_compute_api::BackendService::clear_description |
( |
| ) |
|
|
inline |
Clears the 'description
' attribute.
◆ clear_enable_cdn()
void google_compute_api::BackendService::clear_enable_cdn |
( |
| ) |
|
|
inline |
Clears the 'enableCDN
' attribute.
◆ clear_fingerprint()
void google_compute_api::BackendService::clear_fingerprint |
( |
| ) |
|
|
inline |
Clears the 'fingerprint
' attribute.
◆ clear_health_checks()
void google_compute_api::BackendService::clear_health_checks |
( |
| ) |
|
|
inline |
Clears the 'healthChecks
' attribute.
◆ clear_iap()
void google_compute_api::BackendService::clear_iap |
( |
| ) |
|
|
inline |
Clears the 'iap
' attribute.
◆ clear_id()
void google_compute_api::BackendService::clear_id |
( |
| ) |
|
|
inline |
Clears the 'id
' attribute.
◆ clear_kind()
void google_compute_api::BackendService::clear_kind |
( |
| ) |
|
|
inline |
Clears the 'kind
' attribute.
◆ clear_load_balancing_scheme()
void google_compute_api::BackendService::clear_load_balancing_scheme |
( |
| ) |
|
|
inline |
Clears the 'loadBalancingScheme
' attribute.
◆ clear_name()
void google_compute_api::BackendService::clear_name |
( |
| ) |
|
|
inline |
Clears the 'name
' attribute.
◆ clear_port()
void google_compute_api::BackendService::clear_port |
( |
| ) |
|
|
inline |
Clears the 'port
' attribute.
◆ clear_port_name()
void google_compute_api::BackendService::clear_port_name |
( |
| ) |
|
|
inline |
Clears the 'portName
' attribute.
◆ clear_protocol()
void google_compute_api::BackendService::clear_protocol |
( |
| ) |
|
|
inline |
Clears the 'protocol
' attribute.
◆ clear_region()
void google_compute_api::BackendService::clear_region |
( |
| ) |
|
|
inline |
Clears the 'region
' attribute.
◆ clear_security_policy()
void google_compute_api::BackendService::clear_security_policy |
( |
| ) |
|
|
inline |
Clears the 'securityPolicy
' attribute.
◆ clear_self_link()
void google_compute_api::BackendService::clear_self_link |
( |
| ) |
|
|
inline |
Clears the 'selfLink
' attribute.
◆ clear_session_affinity()
void google_compute_api::BackendService::clear_session_affinity |
( |
| ) |
|
|
inline |
Clears the 'sessionAffinity
' attribute.
◆ clear_timeout_sec()
void google_compute_api::BackendService::clear_timeout_sec |
( |
| ) |
|
|
inline |
Clears the 'timeoutSec
' attribute.
◆ get_affinity_cookie_ttl_sec()
int32 google_compute_api::BackendService::get_affinity_cookie_ttl_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'affinityCookieTtlSec
' attribute.
◆ get_backends()
const client::JsonCppArray<Backend > google_compute_api::BackendService::get_backends |
( |
| ) |
const |
Get a reference to the value of the 'backends
' attribute.
◆ get_cdn_policy()
Get a reference to the value of the 'cdnPolicy
' attribute.
◆ get_connection_draining()
const ConnectionDraining google_compute_api::BackendService::get_connection_draining |
( |
| ) |
const |
Get a reference to the value of the 'connectionDraining
' attribute.
◆ get_creation_timestamp()
const StringPiece google_compute_api::BackendService::get_creation_timestamp |
( |
| ) |
const |
|
inline |
Get the value of the 'creationTimestamp
' attribute.
◆ get_custom_request_headers()
const client::JsonCppArray<string > google_compute_api::BackendService::get_custom_request_headers |
( |
| ) |
const |
|
inline |
Get a reference to the value of the 'customRequestHeaders
' attribute.
◆ get_description()
const StringPiece google_compute_api::BackendService::get_description |
( |
| ) |
const |
|
inline |
Get the value of the 'description
' attribute.
◆ get_enable_cdn()
bool google_compute_api::BackendService::get_enable_cdn |
( |
| ) |
const |
|
inline |
Get the value of the 'enableCDN
' attribute.
◆ get_fingerprint()
const StringPiece google_compute_api::BackendService::get_fingerprint |
( |
| ) |
const |
|
inline |
Get the value of the 'fingerprint
' attribute.
◆ get_health_checks()
const client::JsonCppArray<string > google_compute_api::BackendService::get_health_checks |
( |
| ) |
const |
|
inline |
Get a reference to the value of the 'healthChecks
' attribute.
◆ get_iap()
Get a reference to the value of the 'iap
' attribute.
◆ get_id()
uint64 google_compute_api::BackendService::get_id |
( |
| ) |
const |
|
inline |
Get the value of the 'id
' attribute.
◆ get_kind()
const StringPiece google_compute_api::BackendService::get_kind |
( |
| ) |
const |
|
inline |
Get the value of the 'kind
' attribute.
◆ get_load_balancing_scheme()
const StringPiece google_compute_api::BackendService::get_load_balancing_scheme |
( |
| ) |
const |
|
inline |
Get the value of the 'loadBalancingScheme
' attribute.
◆ get_name()
const StringPiece google_compute_api::BackendService::get_name |
( |
| ) |
const |
|
inline |
Get the value of the 'name
' attribute.
◆ get_port()
int32 google_compute_api::BackendService::get_port |
( |
| ) |
const |
|
inline |
Get the value of the 'port
' attribute.
◆ get_port_name()
const StringPiece google_compute_api::BackendService::get_port_name |
( |
| ) |
const |
|
inline |
Get the value of the 'portName
' attribute.
◆ get_protocol()
const StringPiece google_compute_api::BackendService::get_protocol |
( |
| ) |
const |
|
inline |
Get the value of the 'protocol
' attribute.
◆ get_region()
const StringPiece google_compute_api::BackendService::get_region |
( |
| ) |
const |
|
inline |
Get the value of the 'region
' attribute.
◆ get_security_policy()
const StringPiece google_compute_api::BackendService::get_security_policy |
( |
| ) |
const |
|
inline |
Get the value of the 'securityPolicy
' attribute.
◆ get_self_link()
const StringPiece google_compute_api::BackendService::get_self_link |
( |
| ) |
const |
|
inline |
Get the value of the 'selfLink
' attribute.
◆ get_session_affinity()
const StringPiece google_compute_api::BackendService::get_session_affinity |
( |
| ) |
const |
|
inline |
Get the value of the 'sessionAffinity
' attribute.
◆ get_timeout_sec()
int32 google_compute_api::BackendService::get_timeout_sec |
( |
| ) |
const |
|
inline |
Get the value of the 'timeoutSec
' attribute.
◆ GetTypeName()
const StringPiece google_compute_api::BackendService::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_affinity_cookie_ttl_sec()
bool google_compute_api::BackendService::has_affinity_cookie_ttl_sec |
( |
| ) |
const |
|
inline |
Determine if the 'affinityCookieTtlSec
' attribute was set.
- Returns
- true if the '
affinityCookieTtlSec
' attribute was set.
◆ has_backends()
bool google_compute_api::BackendService::has_backends |
( |
| ) |
const |
|
inline |
Determine if the 'backends
' attribute was set.
- Returns
- true if the '
backends
' attribute was set.
◆ has_cdn_policy()
bool google_compute_api::BackendService::has_cdn_policy |
( |
| ) |
const |
|
inline |
Determine if the 'cdnPolicy
' attribute was set.
- Returns
- true if the '
cdnPolicy
' attribute was set.
◆ has_connection_draining()
bool google_compute_api::BackendService::has_connection_draining |
( |
| ) |
const |
|
inline |
Determine if the 'connectionDraining
' attribute was set.
- Returns
- true if the '
connectionDraining
' attribute was set.
◆ has_creation_timestamp()
bool google_compute_api::BackendService::has_creation_timestamp |
( |
| ) |
const |
|
inline |
Determine if the 'creationTimestamp
' attribute was set.
- Returns
- true if the '
creationTimestamp
' attribute was set.
◆ has_custom_request_headers()
bool google_compute_api::BackendService::has_custom_request_headers |
( |
| ) |
const |
|
inline |
Determine if the 'customRequestHeaders
' attribute was set.
- Returns
- true if the '
customRequestHeaders
' attribute was set.
◆ has_description()
bool google_compute_api::BackendService::has_description |
( |
| ) |
const |
|
inline |
Determine if the 'description
' attribute was set.
- Returns
- true if the '
description
' attribute was set.
◆ has_enable_cdn()
bool google_compute_api::BackendService::has_enable_cdn |
( |
| ) |
const |
|
inline |
Determine if the 'enableCDN
' attribute was set.
- Returns
- true if the '
enableCDN
' attribute was set.
◆ has_fingerprint()
bool google_compute_api::BackendService::has_fingerprint |
( |
| ) |
const |
|
inline |
Determine if the 'fingerprint
' attribute was set.
- Returns
- true if the '
fingerprint
' attribute was set.
◆ has_health_checks()
bool google_compute_api::BackendService::has_health_checks |
( |
| ) |
const |
|
inline |
Determine if the 'healthChecks
' attribute was set.
- Returns
- true if the '
healthChecks
' attribute was set.
◆ has_iap()
bool google_compute_api::BackendService::has_iap |
( |
| ) |
const |
|
inline |
Determine if the 'iap
' attribute was set.
- Returns
- true if the '
iap
' attribute was set.
◆ has_id()
bool google_compute_api::BackendService::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::BackendService::has_kind |
( |
| ) |
const |
|
inline |
Determine if the 'kind
' attribute was set.
- Returns
- true if the '
kind
' attribute was set.
◆ has_load_balancing_scheme()
bool google_compute_api::BackendService::has_load_balancing_scheme |
( |
| ) |
const |
|
inline |
Determine if the 'loadBalancingScheme
' attribute was set.
- Returns
- true if the '
loadBalancingScheme
' attribute was set.
◆ has_name()
bool google_compute_api::BackendService::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::BackendService::has_port |
( |
| ) |
const |
|
inline |
Determine if the 'port
' attribute was set.
- Returns
- true if the '
port
' attribute was set.
◆ has_port_name()
bool google_compute_api::BackendService::has_port_name |
( |
| ) |
const |
|
inline |
Determine if the 'portName
' attribute was set.
- Returns
- true if the '
portName
' attribute was set.
◆ has_protocol()
bool google_compute_api::BackendService::has_protocol |
( |
| ) |
const |
|
inline |
Determine if the 'protocol
' attribute was set.
- Returns
- true if the '
protocol
' attribute was set.
◆ has_region()
bool google_compute_api::BackendService::has_region |
( |
| ) |
const |
|
inline |
Determine if the 'region
' attribute was set.
- Returns
- true if the '
region
' attribute was set.
◆ has_security_policy()
bool google_compute_api::BackendService::has_security_policy |
( |
| ) |
const |
|
inline |
Determine if the 'securityPolicy
' attribute was set.
- Returns
- true if the '
securityPolicy
' attribute was set.
◆ has_self_link()
bool google_compute_api::BackendService::has_self_link |
( |
| ) |
const |
|
inline |
Determine if the 'selfLink
' attribute was set.
- Returns
- true if the '
selfLink
' attribute was set.
◆ has_session_affinity()
bool google_compute_api::BackendService::has_session_affinity |
( |
| ) |
const |
|
inline |
Determine if the 'sessionAffinity
' attribute was set.
- Returns
- true if the '
sessionAffinity
' attribute was set.
◆ has_timeout_sec()
bool google_compute_api::BackendService::has_timeout_sec |
( |
| ) |
const |
|
inline |
Determine if the 'timeoutSec
' attribute was set.
- Returns
- true if the '
timeoutSec
' attribute was set.
◆ mutable_backends()
client::JsonCppArray<Backend > google_compute_api::BackendService::mutable_backends |
( |
| ) |
|
Gets a reference to a mutable value of the 'backends
' property.
The list of backends that serve this BackendService.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_cdnPolicy()
Gets a reference to a mutable value of the 'cdnPolicy
' property.
Cloud CDN configuration for this BackendService.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_connectionDraining()
Gets a reference to a mutable value of the 'connectionDraining
' property.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_customRequestHeaders()
client::JsonCppArray<string > google_compute_api::BackendService::mutable_customRequestHeaders |
( |
| ) |
|
|
inline |
Gets a reference to a mutable value of the 'customRequestHeaders
' property.
Headers that the HTTP/S load balancer should add to proxied requests.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_healthChecks()
client::JsonCppArray<string > google_compute_api::BackendService::mutable_healthChecks |
( |
| ) |
|
|
inline |
Gets a reference to a mutable value of the 'healthChecks
' property.
The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend.
For internal load balancing, a URL to a HealthCheck resource must be specified instead.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_iap()
Gets a reference to a mutable value of the 'iap
' 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_affinity_cookie_ttl_sec()
void google_compute_api::BackendService::set_affinity_cookie_ttl_sec |
( |
int32 |
value | ) |
|
|
inline |
Change the 'affinityCookieTtlSec
' attribute.
Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
- Parameters
-
◆ set_creation_timestamp()
void google_compute_api::BackendService::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::BackendService::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_enable_cdn()
void google_compute_api::BackendService::set_enable_cdn |
( |
bool |
value | ) |
|
|
inline |
Change the 'enableCDN
' attribute.
If true, enable Cloud CDN for this BackendService.
When the load balancing scheme is INTERNAL, this field is not used.
- Parameters
-
◆ set_fingerprint()
void google_compute_api::BackendService::set_fingerprint |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'fingerprint
' attribute.
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve a BackendService.
- Parameters
-
◆ set_id()
void google_compute_api::BackendService::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::BackendService::set_kind |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'kind
' attribute.
[Output Only] Type of resource. Always compute::backendService for backend services.
- Parameters
-
◆ set_load_balancing_scheme()
void google_compute_api::BackendService::set_load_balancing_scheme |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'loadBalancingScheme
' attribute.
Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
- Parameters
-
◆ set_name()
void google_compute_api::BackendService::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::BackendService::set_port |
( |
int32 |
value | ) |
|
|
inline |
Change the 'port
' attribute.
- Deprecated:
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
This cannot be used for internal load balancing.
- Parameters
-
◆ set_port_name()
void google_compute_api::BackendService::set_port_name |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'portName
' attribute.
Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
When the load balancing scheme is INTERNAL, this field is not used.
- Parameters
-
◆ set_protocol()
void google_compute_api::BackendService::set_protocol |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'protocol
' attribute.
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
- Parameters
-
◆ set_region()
void google_compute_api::BackendService::set_region |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'region
' attribute.
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- Parameters
-
◆ set_security_policy()
void google_compute_api::BackendService::set_security_policy |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'securityPolicy
' attribute.
[Output Only] The resource URL for the security policy associated with this backend service.
- Parameters
-
◆ set_self_link()
void google_compute_api::BackendService::set_self_link |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'selfLink
' attribute.
[Output Only] Server-defined URL for the resource.
- Parameters
-
◆ set_session_affinity()
void google_compute_api::BackendService::set_session_affinity |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'sessionAffinity
' attribute.
Type of session affinity to use. The default is NONE.
When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
When the protocol is UDP, this field is not used.
- Parameters
-
◆ set_timeout_sec()
void google_compute_api::BackendService::set_timeout_sec |
( |
int32 |
value | ) |
|
|
inline |
Change the 'timeoutSec
' attribute.
How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
- Parameters
-
The documentation for this class was generated from the following files: