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

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

Overview

A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.

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



1308
1309
1310
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1308

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) 


1178
1179
1180
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1178

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:



1183
1184
1185
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1183

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:



1188
1189
1190
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1188

def cdn_policy
  @cdn_policy
end

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

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

Returns:



1193
1194
1195
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1193

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) 


1198
1199
1200
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1198

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


1204
1205
1206
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1204

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) 


1210
1211
1212
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1210

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

Returns:

  • (String) 


1220
1221
1222
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1220

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 internal load balancing, a URL to a HealthCheck resource must be specified instead. Corresponds to the JSON property healthChecks

Returns:

  • (Array<String>) 


1229
1230
1231
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1229

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


1235
1236
1237
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1235

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) 


1241
1242
1243
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1241

def kind
  @kind
end

#load_balancing_scheme ⇒ String

Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String) 


1246
1247
1248
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1246

def load_balancing_scheme
  @load_balancing_scheme
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? 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) 


1256
1257
1258
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1256

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) 


1263
1264
1265
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1263

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) 


1271
1272
1273
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1271

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) 


1279
1280
1281
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1279

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

Returns:

  • (String) 


1285
1286
1287
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1285

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


1290
1291
1292
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1290

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


1300
1301
1302
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1300

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) 


1306
1307
1308
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1306

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1313

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)
  @connection_draining = args[:connection_draining] if args.key?(:connection_draining)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @health_checks = args[:health_checks] if args.key?(:health_checks)
  @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)
  @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)
  @self_link = args[:self_link] if args.key?(:self_link)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end