Class: Google::Apis::ComputeAlpha::BackendService

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

Overview

A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BackendService

Returns a new instance of BackendService



3294
3295
3296
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3294

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

Instance Attribute Details

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

Returns:

  • (Fixnum) 


3113
3114
3115
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3113

def affinity_cookie_ttl_sec
  @affinity_cookie_ttl_sec
end

#app_engine_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend

Configuration of a App Engine backend. Corresponds to the JSON property appEngineBackend

Returns:



3118
3119
3120
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3118

def app_engine_backend
  @app_engine_backend
end

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

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

Returns:



3123
3124
3125
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3123

def backends
  @backends
end

#cdn_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceCdnPolicy

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

Returns:



3128
3129
3130
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3128

def cdn_policy
  @cdn_policy
end

#cloud_function_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend

Configuration of a Cloud Function backend. Corresponds to the JSON property cloudFunctionBackend

Returns:



3133
3134
3135
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3133

def cloud_function_backend
  @cloud_function_backend
end

#connection_draining ⇒ Google::Apis::ComputeAlpha::ConnectionDraining

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

Returns:



3138
3139
3140
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3138

def connection_draining
  @connection_draining
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


3143
3144
3145
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3143

def creation_timestamp
  @creation_timestamp
end

#custom_request_headers ⇒ Array<String>

Headers that the HTTP/S load balancer should add to proxied requests. Corresponds to the JSON property customRequestHeaders

Returns:

  • (Array<String>) 


3148
3149
3150
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3148

def custom_request_headers
  @custom_request_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) 


3154
3155
3156
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3154

def description
  @description
end

#enable_cdn ⇒ Boolean Also known as: enable_cdn?

If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. Corresponds to the JSON property enableCDN

Returns:

  • (Boolean) 


3160
3161
3162
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3160

def enable_cdn
  @enable_cdn
end

#failover_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy

Corresponds to the JSON property failoverPolicy

Returns:



3166
3167
3168
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3166

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) 


3178
3179
3180
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3178

def fingerprint
  @fingerprint
end

#health_checks ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3189
3190
3191
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3189

def health_checks
  @health_checks
end

#iap ⇒ Google::Apis::ComputeAlpha::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



3194
3195
3196
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3194

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) 


3200
3201
3202
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3200

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) 


3206
3207
3208
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3206

def kind
  @kind
end

#load_balancing_scheme ⇒ String

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

Returns:

  • (String) 


3213
3214
3215
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3213

def load_balancing_scheme
  @load_balancing_scheme
end

#log_config ⇒ Google::Apis::ComputeAlpha::BackendServiceLogConfig

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

Returns:



3219
3220
3221
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3219

def log_config
  @log_config
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) 


3229
3230
3231
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3229

def name
  @name
end

#port ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3236
3237
3238
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3236

def port
  @port
end

#port_name ⇒ String

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

Returns:

  • (String) 


3244
3245
3246
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3244

def port_name
  @port_name
end

#protocol ⇒ String

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

Returns:

  • (String) 


3252
3253
3254
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3252

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) 


3260
3261
3262
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3260

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) 


3266
3267
3268
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3266

def security_policy
  @security_policy
end

#self_link ⇒ String

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

Returns:

  • (String) 


3271
3272
3273
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3271

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


3276
3277
3278
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3276

def self_link_with_id
  @self_link_with_id
end

#session_affinity ⇒ String

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

Returns:

  • (String) 


3286
3287
3288
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3286

def session_affinity
  @session_affinity
end

#timeout_sec ⇒ Fixnum

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum) 


3292
3293
3294
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3292

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3299

def update!(**args)
  @affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec)
  @app_engine_backend = args[:app_engine_backend] if args.key?(:app_engine_backend)
  @backends = args[:backends] if args.key?(:backends)
  @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy)
  @cloud_function_backend = args[:cloud_function_backend] if args.key?(:cloud_function_backend)
  @connection_draining = args[:connection_draining] if args.key?(:connection_draining)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers)
  @description = args[:description] if args.key?(:description)
  @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)
  @log_config = args[:log_config] if args.key?(:log_config)
  @name = args[:name] if args.key?(:name)
  @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)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end