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



2233
2234
2235
# File 'generated/google/apis/compute_alpha/classes.rb', line 2233

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

Instance Attribute Details

#balancing_modeString

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)


2136
2137
2138
# File 'generated/google/apis/compute_alpha/classes.rb', line 2136

def balancing_mode
  @balancing_mode
end

#capacity_scalerFloat

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)


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

def capacity_scaler
  @capacity_scaler
end

#descriptionString

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

Returns:

  • (String)


2152
2153
2154
# File 'generated/google/apis/compute_alpha/classes.rb', line 2152

def description
  @description
end

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


2158
2159
2160
# File 'generated/google/apis/compute_alpha/classes.rb', line 2158

def failover
  @failover
end

#groupString

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)


2172
2173
2174
# File 'generated/google/apis/compute_alpha/classes.rb', line 2172

def group
  @group
end

#max_connectionsFixnum

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)


2180
2181
2182
# File 'generated/google/apis/compute_alpha/classes.rb', line 2180

def max_connections
  @max_connections
end

#max_connections_per_endpointFixnum

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)


2189
2190
2191
# File 'generated/google/apis/compute_alpha/classes.rb', line 2189

def max_connections_per_endpoint
  @max_connections_per_endpoint
end

#max_connections_per_instanceFixnum

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)


2198
2199
2200
# File 'generated/google/apis/compute_alpha/classes.rb', line 2198

def max_connections_per_instance
  @max_connections_per_instance
end

#max_rateFixnum

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)


2206
2207
2208
# File 'generated/google/apis/compute_alpha/classes.rb', line 2206

def max_rate
  @max_rate
end

#max_rate_per_endpointFloat

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)


2215
2216
2217
# File 'generated/google/apis/compute_alpha/classes.rb', line 2215

def max_rate_per_endpoint
  @max_rate_per_endpoint
end

#max_rate_per_instanceFloat

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)


2224
2225
2226
# File 'generated/google/apis/compute_alpha/classes.rb', line 2224

def max_rate_per_instance
  @max_rate_per_instance
end

#max_utilizationFloat

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)


2231
2232
2233
# File 'generated/google/apis/compute_alpha/classes.rb', line 2231

def max_utilization
  @max_utilization
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
# File 'generated/google/apis/compute_alpha/classes.rb', line 2238

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