Class: Google::Apis::ComputeAlpha::Backend
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Backend
- 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
-
#balancing_mode ⇒ String
Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded.
-
#capacity_scaler ⇒ Float
A multiplier applied to the backend's target capacity of its balancing mode.
-
#description ⇒ String
An optional description of this resource.
-
#failover ⇒ Boolean
(also: #failover?)
This field designates whether this is a failover backend.
-
#group ⇒ String
The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
-
#max_connections ⇒ Fixnum
Defines a target maximum number of simultaneous connections.
-
#max_connections_per_endpoint ⇒ Fixnum
Defines a target maximum number of simultaneous connections.
-
#max_connections_per_instance ⇒ Fixnum
Defines a target maximum number of simultaneous connections.
-
#max_rate ⇒ Fixnum
Defines a maximum number of HTTP requests per second (RPS).
-
#max_rate_per_endpoint ⇒ Float
Defines a maximum target for requests per second (RPS).
-
#max_rate_per_instance ⇒ Float
Defines a maximum target for requests per second (RPS).
-
#max_utilization ⇒ Float
Optional parameter to define a target capacity for the UTILIZATION balancing mode.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Backend
constructor
A new instance of Backend.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Backend
Returns a new instance of Backend.
2903 2904 2905 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2903 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
2818 2819 2820 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2818 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.
Corresponds to the JSON property capacityScaler
2829 2830 2831 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2829 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
2835 2836 2837 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2835 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
2841 2842 2843 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2841 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
2852 2853 2854 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2852 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
2859 2860 2861 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2859 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
2866 2867 2868 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2866 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
2873 2874 2875 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2873 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
2880 2881 2882 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2880 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
2887 2888 2889 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2887 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
2894 2895 2896 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2894 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
2901 2902 2903 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2901 def max_utilization @max_utilization end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 2908 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 |