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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.



2893
2894
2895
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2893

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. Corresponds to the JSON property balancingMode

Returns:

  • (String) 


2795
2796
2797
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2795

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 supported by:

  • Internal TCP/UDP Load Balancing - Network Load Balancing Corresponds to the JSON property capacityScaler

Returns:

  • (Float) 


2808
2809
2810
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2808

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) 


2814
2815
2816
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2814

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) 


2820
2821
2822
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2820

def failover
  @failover
end

#group ⇒ String

The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

  • When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
  • When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported. For regional services, the backend must be in the same region as the backend service. 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) 


2841
2842
2843
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2841

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. Not supported by:

  • Internal TCP/UDP Load Balancing - Network Load Balancing Corresponds to the JSON property maxConnections

Returns:

  • (Fixnum) 


2849
2850
2851
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2849

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. Not supported by:

  • Internal TCP/UDP Load Balancing - Network Load Balancing. Corresponds to the JSON property maxConnectionsPerEndpoint

Returns:

  • (Fixnum) 


2857
2858
2859
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2857

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. Not supported by:

  • Internal TCP/UDP Load Balancing - Network Load Balancing. Corresponds to the JSON property maxConnectionsPerInstance

Returns:

  • (Fixnum) 


2865
2866
2867
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2865

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) 


2872
2873
2874
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2872

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) 


2879
2880
2881
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2879

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) 


2886
2887
2888
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2886

def max_rate_per_instance
  @max_rate_per_instance
end

#max_utilization ⇒ Float

Corresponds to the JSON property maxUtilization

Returns:

  • (Float) 


2891
2892
2893
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2891

def max_utilization
  @max_utilization
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2898

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