Class: Google::Apis::ComputeBeta::Backend

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

Overview

Message containing information of one individual backend.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Backend

Returns a new instance of Backend.



2866
2867
2868
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2866

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

Instance Attribute Details

#balancing_mode ⇒ String

Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend. maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. Corresponds to the JSON property balancingMode

Returns:

  • (String) 


2769
2770
2771
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2769

def balancing_mode
  @balancing_mode
end

#capacity_scaler ⇒ Float

A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don' t support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. Corresponds to the JSON property capacityScaler

Returns:

  • (Float) 


2782
2783
2784
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2782

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) 


2788
2789
2790
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2788

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) 


2794
2795
2796
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2794

def failover
  @failover
end

#group ⇒ String

The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. Corresponds to the JSON property group

Returns:

  • (String) 


2805
2806
2807
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2805

def group
  @group
end

#max_connections ⇒ Fixnum

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Corresponds to the JSON property maxConnections

Returns:

  • (Fixnum) 


2812
2813
2814
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2812

def max_connections
  @max_connections
end

#max_connections_per_endpoint ⇒ Fixnum

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Corresponds to the JSON property maxConnectionsPerEndpoint

Returns:

  • (Fixnum) 


2819
2820
2821
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2819

def max_connections_per_endpoint
  @max_connections_per_endpoint
end

#max_connections_per_instance ⇒ Fixnum

Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Corresponds to the JSON property maxConnectionsPerInstance

Returns:

  • (Fixnum) 


2826
2827
2828
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2826

def max_connections_per_instance
  @max_connections_per_instance
end

#max_rate ⇒ Fixnum

Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. Corresponds to the JSON property maxRate

Returns:

  • (Fixnum) 


2833
2834
2835
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2833

def max_rate
  @max_rate
end

#max_rate_per_endpoint ⇒ Float

Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. Corresponds to the JSON property maxRatePerEndpoint

Returns:

  • (Float) 


2840
2841
2842
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2840

def max_rate_per_endpoint
  @max_rate_per_endpoint
end

#max_rate_per_instance ⇒ Float

Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. Corresponds to the JSON property maxRatePerInstance

Returns:

  • (Float) 


2847
2848
2849
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2847

def max_rate_per_instance
  @max_rate_per_instance
end

#max_utilization ⇒ Float

Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode. Corresponds to the JSON property maxUtilization

Returns:

  • (Float) 


2854
2855
2856
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2854

def max_utilization
  @max_utilization
end

#preference ⇒ String

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Corresponds to the JSON property preference

Returns:

  • (String) 


2864
2865
2866
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2864

def preference
  @preference
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
 
# File 'lib/google/apis/compute_beta/classes.rb', line 2871

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