Class: Google::Apis::ComputeV1::Backend

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

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



2039
2040
2041
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2039

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) 


1943
1944
1945
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1943

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) 


1953
1954
1955
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1953

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) 


1959
1960
1961
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1959

def description
  @description
end

#group ⇒ String

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this 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. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint 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. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. Corresponds to the JSON property group

Returns:

  • (String) 


1978
1979
1980
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1978

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) 


1986
1987
1988
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1986

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) 


1995
1996
1997
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1995

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) 


2004
2005
2006
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2004

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) 


2012
2013
2014
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2012

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) 


2021
2022
2023
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2021

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) 


2030
2031
2032
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2030

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) 


2037
2038
2039
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2037

def max_utilization
  @max_utilization
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2044

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