Class: Google::Apis::ComputeV1::BackendService

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * Global * Regional For more information, see Backend Services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackendService

Returns a new instance of BackendService.



3639
3640
3641
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3639

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Corresponds to the JSON property affinityCookieTtlSec

Returns:

  • (Fixnum) 


3332
3333
3334
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3332

def affinity_cookie_ttl_sec
  @affinity_cookie_ttl_sec
end

#backends ⇒ Array<Google::Apis::ComputeV1::Backend>

The list of backends that serve this BackendService. Corresponds to the JSON property backends

Returns:



3337
3338
3339
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3337

def backends
  @backends
end

#cdn_policy ⇒ Google::Apis::ComputeV1::BackendServiceCdnPolicy

Message containing Cloud CDN configuration for a backend service. Corresponds to the JSON property cdnPolicy

Returns:



3342
3343
3344
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3342

def cdn_policy
  @cdn_policy
end

#circuit_breakers ⇒ Google::Apis::ComputeV1::CircuitBreakers

Settings controlling the volume of requests, connections and retries to this backend service. Corresponds to the JSON property circuitBreakers

Returns:



3348
3349
3350
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3348

def circuit_breakers
  @circuit_breakers
end

#compression_mode ⇒ String

Compress text responses using Brotli or gzip compression, based on the client' s Accept-Encoding header. Corresponds to the JSON property compressionMode

Returns:

  • (String) 


3354
3355
3356
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3354

def compression_mode
  @compression_mode
end

#connection_draining ⇒ Google::Apis::ComputeV1::ConnectionDraining

Message containing connection draining configuration. Corresponds to the JSON property connectionDraining

Returns:



3359
3360
3361
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3359

def connection_draining
  @connection_draining
end

#connection_tracking_policy ⇒ Google::Apis::ComputeV1::BackendServiceConnectionTrackingPolicy

Connection Tracking configuration for this BackendService. Corresponds to the JSON property connectionTrackingPolicy

Returns:



3364
3365
3366
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3364

def connection_tracking_policy
  @connection_tracking_policy
end

#consistent_hash ⇒ Google::Apis::ComputeV1::ConsistentHashLoadBalancerSettings

This message defines settings for a consistent hash style load balancer. Corresponds to the JSON property consistentHash

Returns:



3369
3370
3371
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3369

def consistent_hash
  @consistent_hash
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


3374
3375
3376
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3374

def creation_timestamp
  @creation_timestamp
end

#custom_request_headers ⇒ Array<String>

Headers that the load balancer adds to proxied requests. See Creating custom headers. Corresponds to the JSON property customRequestHeaders

Returns:

  • (Array<String>) 


3380
3381
3382
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3380

def custom_request_headers
  @custom_request_headers
end

#custom_response_headers ⇒ Array<String>

Headers that the load balancer adds to proxied responses. See Creating custom headers. Corresponds to the JSON property customResponseHeaders

Returns:

  • (Array<String>) 


3386
3387
3388
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3386

def custom_response_headers
  @custom_response_headers
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


3392
3393
3394
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3392

def description
  @description
end

#edge_security_policy ⇒ String

[Output Only] The resource URL for the edge security policy associated with this backend service. Corresponds to the JSON property edgeSecurityPolicy

Returns:

  • (String) 


3398
3399
3400
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3398

def edge_security_policy
  @edge_security_policy
end

#enable_cdn ⇒ Boolean Also known as: enable_cdn?

If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. Corresponds to the JSON property enableCDN

Returns:

  • (Boolean) 


3404
3405
3406
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3404

def enable_cdn
  @enable_cdn
end

#failover_policy ⇒ Google::Apis::ComputeV1::BackendServiceFailoverPolicy

For load balancers that have configurable failover: Internal passthrough Network Load Balancers and external passthrough Network Load Balancers. On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). Corresponds to the JSON property failoverPolicy

Returns:



3419
3420
3421
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3419

def failover_policy
  @failover_policy
end

#fingerprint ⇒ String

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. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3430
3431
3432
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3430

def fingerprint
  @fingerprint
end

#health_checks ⇒ Array<String>

The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. Corresponds to the JSON property healthChecks

Returns:

  • (Array<String>) 


3441
3442
3443
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3441

def health_checks
  @health_checks
end

#iap ⇒ Google::Apis::ComputeV1::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



3446
3447
3448
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3446

def iap
  @iap
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


3452
3453
3454
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3452

def id
  @id
end

#kind ⇒ String

[Output Only] Type of resource. Always compute#backendService for backend services. Corresponds to the JSON property kind

Returns:

  • (String) 


3458
3459
3460
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3458

def kind
  @kind
end

#load_balancing_scheme ⇒ String

Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String) 


3465
3466
3467
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3465

def load_balancing_scheme
  @load_balancing_scheme
end

#locality_lb_policies ⇒ Array<Google::Apis::ComputeV1::BackendServiceLocalityLoadBalancingPolicyConfig>

A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. Corresponds to the JSON property localityLbPolicies

Returns:



3477
3478
3479
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3477

def locality_lb_policies
  @locality_lb_policies
end

#locality_lb_policy ⇒ String

The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Corresponds to the JSON property localityLbPolicy

Returns:

  • (String) 


3504
3505
3506
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3504

def locality_lb_policy
  @locality_lb_policy
end

#log_config ⇒ Google::Apis::ComputeV1::BackendServiceLogConfig

The available logging options for the load balancer traffic served by this backend service. Corresponds to the JSON property logConfig

Returns:



3510
3511
3512
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3510

def log_config
  @log_config
end

#max_stream_duration ⇒ Google::Apis::ComputeV1::Duration

A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10, 000 years. Corresponds to the JSON property maxStreamDuration

Returns:



3518
3519
3520
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3518

def max_stream_duration
  @max_stream_duration
end

#metadatas ⇒ Hash<String,String>

Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH Corresponds to the JSON property metadatas

Returns:

  • (Hash<String,String>) 


3524
3525
3526
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3524

def metadatas
  @metadatas
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


3534
3535
3536
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3534

def name
  @name
end

#network ⇒ String

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. Corresponds to the JSON property network

Returns:

  • (String) 


3540
3541
3542
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3540

def network
  @network
end

#outlier_detection ⇒ Google::Apis::ComputeV1::OutlierDetection

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. Corresponds to the JSON property outlierDetection

Returns:



3546
3547
3548
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3546

def outlier_detection
  @outlier_detection
end

#port ⇒ Fixnum

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


3553
3554
3555
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3553

def port
  @port
end

#port_name ⇒ String

A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name. Corresponds to the JSON property portName

Returns:

  • (String) 


3563
3564
3565
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3563

def port_name
  @port_name
end

#protocol ⇒ String

The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Corresponds to the JSON property protocol

Returns:

  • (String) 


3573
3574
3575
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3573

def protocol
  @protocol
end

#region ⇒ String

[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. Corresponds to the JSON property region

Returns:

  • (String) 


3581
3582
3583
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3581

def region
  @region
end

#security_policy ⇒ String

[Output Only] The resource URL for the security policy associated with this backend service. Corresponds to the JSON property securityPolicy

Returns:

  • (String) 


3587
3588
3589
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3587

def security_policy
  @security_policy
end

#security_settings ⇒ Google::Apis::ComputeV1::SecuritySettings

The authentication and authorization settings for a BackendService. Corresponds to the JSON property securitySettings

Returns:



3592
3593
3594
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3592

def security_settings
  @security_settings
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


3597
3598
3599
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3597

def self_link
  @self_link
end

#service_bindings ⇒ Array<String>

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. Corresponds to the JSON property serviceBindings

Returns:

  • (Array<String>) 


3604
3605
3606
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3604

def service_bindings
  @service_bindings
end

#session_affinity ⇒ String

Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity. Corresponds to the JSON property sessionAffinity

Returns:

  • (String) 


3613
3614
3615
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3613

def session_affinity
  @session_affinity
end

#subsetting ⇒ Google::Apis::ComputeV1::Subsetting

Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. Corresponds to the JSON property subsetting

Returns:



3620
3621
3622
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3620

def subsetting
  @subsetting
end

#timeout_sec ⇒ Fixnum

The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2, 147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum) 


3632
3633
3634
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3632

def timeout_sec
  @timeout_sec
end

#used_by ⇒ Array<Google::Apis::ComputeV1::BackendServiceUsedBy>

Corresponds to the JSON property usedBy

Returns:



3637
3638
3639
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3637

def used_by
  @used_by
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3644

def update!(**args)
  @affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec)
  @backends = args[:backends] if args.key?(:backends)
  @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy)
  @circuit_breakers = args[:circuit_breakers] if args.key?(:circuit_breakers)
  @compression_mode = args[:compression_mode] if args.key?(:compression_mode)
  @connection_draining = args[:connection_draining] if args.key?(:connection_draining)
  @connection_tracking_policy = args[:connection_tracking_policy] if args.key?(:connection_tracking_policy)
  @consistent_hash = args[:consistent_hash] if args.key?(:consistent_hash)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers)
  @custom_response_headers = args[:custom_response_headers] if args.key?(:custom_response_headers)
  @description = args[:description] if args.key?(:description)
  @edge_security_policy = args[:edge_security_policy] if args.key?(:edge_security_policy)
  @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn)
  @failover_policy = args[:failover_policy] if args.key?(:failover_policy)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @health_checks = args[:health_checks] if args.key?(:health_checks)
  @iap = args[:iap] if args.key?(:iap)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
  @locality_lb_policies = args[:locality_lb_policies] if args.key?(:locality_lb_policies)
  @locality_lb_policy = args[:locality_lb_policy] if args.key?(:locality_lb_policy)
  @log_config = args[:log_config] if args.key?(:log_config)
  @max_stream_duration = args[:max_stream_duration] if args.key?(:max_stream_duration)
  @metadatas = args[:metadatas] if args.key?(:metadatas)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @outlier_detection = args[:outlier_detection] if args.key?(:outlier_detection)
  @port = args[:port] if args.key?(:port)
  @port_name = args[:port_name] if args.key?(:port_name)
  @protocol = args[:protocol] if args.key?(:protocol)
  @region = args[:region] if args.key?(:region)
  @security_policy = args[:security_policy] if args.key?(:security_policy)
  @security_settings = args[:security_settings] if args.key?(:security_settings)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_bindings = args[:service_bindings] if args.key?(:service_bindings)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @subsetting = args[:subsetting] if args.key?(:subsetting)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
  @used_by = args[:used_by] if args.key?(:used_by)
end