Class: Google::Apis::ComputeAlpha::Backend

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

Message containing information of one individual backend.

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

Returns a new instance of Backend



2221
2222
2223
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2221

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

Instance Attribute Details

#balancing_mode ⇒ String

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. Corresponds to the JSON property balancingMode

Returns:

  • (String) 


2124
2125
2126
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2124

def balancing_mode
  @balancing_mode
end

#capacity_scaler ⇒ Float

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. Corresponds to the JSON property capacityScaler

Returns:

  • (Float) 


2134
2135
2136
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2134

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


2140
2141
2142
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2140

def description
  @description
end

#failover ⇒ Boolean Also known as: failover?

This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. Corresponds to the JSON property failover

Returns:

  • (Boolean) 


2146
2147
2148
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2146

def failover
  @failover
end

#group ⇒ String

The fully-qualified URL of a Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. Note that you must specify an Instance Group resource using the fully- qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Corresponds to the JSON property group

Returns:

  • (String) 


2160
2161
2162
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2160

def group
  @group
end

#max_connections ⇒ Fixnum

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxConnections

Returns:

  • (Fixnum) 


2168
2169
2170
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2168

def max_connections
  @max_connections
end

#max_connections_per_endpoint ⇒ Fixnum

The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxConnectionsPerEndpoint

Returns:

  • (Fixnum) 


2177
2178
2179
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2177

def max_connections_per_endpoint
  @max_connections_per_endpoint
end

#max_connections_per_instance ⇒ Fixnum

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxConnectionsPerInstance

Returns:

  • (Fixnum) 


2186
2187
2188
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2186

def max_connections_per_instance
  @max_connections_per_instance
end

#max_rate ⇒ Fixnum

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxRate

Returns:

  • (Fixnum) 


2194
2195
2196
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2194

def max_rate
  @max_rate
end

#max_rate_per_endpoint ⇒ Float

The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxRatePerEndpoint

Returns:

  • (Float) 


2203
2204
2205
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2203

def max_rate_per_endpoint
  @max_rate_per_endpoint
end

#max_rate_per_instance ⇒ Float

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. Corresponds to the JSON property maxRatePerInstance

Returns:

  • (Float) 


2212
2213
2214
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2212

def max_rate_per_instance
  @max_rate_per_instance
end

#max_utilization ⇒ Float

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. Corresponds to the JSON property maxUtilization

Returns:

  • (Float) 


2219
2220
2221
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2219

def max_utilization
  @max_utilization
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2226

def update!(**args)
  @balancing_mode = args[:balancing_mode] if args.key?(:balancing_mode)
  @capacity_scaler = args[:capacity_scaler] if args.key?(:capacity_scaler)
  @description = args[:description] if args.key?(:description)
  @failover = args[:failover] if args.key?(:failover)
  @group = args[:group] if args.key?(:group)
  @max_connections = args[:max_connections] if args.key?(:max_connections)
  @max_connections_per_endpoint = args[:max_connections_per_endpoint] if args.key?(:max_connections_per_endpoint)
  @max_connections_per_instance = args[:max_connections_per_instance] if args.key?(:max_connections_per_instance)
  @max_rate = args[:max_rate] if args.key?(:max_rate)
  @max_rate_per_endpoint = args[:max_rate_per_endpoint] if args.key?(:max_rate_per_endpoint)
  @max_rate_per_instance = args[:max_rate_per_instance] if args.key?(:max_rate_per_instance)
  @max_utilization = args[:max_utilization] if args.key?(:max_utilization)
end