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



3240
3241
3242
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3240

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) 


3071
3072
3073
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3071

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:



3076
3077
3078
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3076

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:



3081
3082
3083
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3081

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:



3086
3087
3088
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3086

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:



3091
3092
3093
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3091

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:



3096
3097
3098
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3096

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) 


3101
3102
3103
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3101

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>) 


3106
3107
3108
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3106

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) 


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

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) 


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

def enable_cdn
  @enable_cdn
end

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

Corresponds to the JSON property failoverPolicy

Returns:



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

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. 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) 


3135
3136
3137
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3135

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>) 


3146
3147
3148
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3146

def health_checks
  @health_checks
end

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

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



3151
3152
3153
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3151

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) 


3157
3158
3159
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3157

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) 


3163
3164
3165
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3163

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) 


3170
3171
3172
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3170

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]([-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) 


3180
3181
3182
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3180

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) 


3187
3188
3189
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3187

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) 


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

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) 


3203
3204
3205
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3203

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) 


3211
3212
3213
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3211

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) 


3217
3218
3219
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3217

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) 


3222
3223
3224
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3222

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) 


3232
3233
3234
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3232

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) 


3238
3239
3240
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3238

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3245

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)
  @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)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end