Class: Google::Apis::ComputeAlpha::Backend
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Backend
- 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
-
#balancing_mode ⇒ String
Specifies the balancing mode for this backend.
-
#capacity_scaler ⇒ Float
A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
-
#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 resource.
-
#max_connections ⇒ Fixnum
The max number of simultaneous connections for the group.
-
#max_connections_per_endpoint ⇒ Fixnum
The max number of simultaneous connections that a single backend network endpoint can handle.
-
#max_connections_per_instance ⇒ Fixnum
The max number of simultaneous connections that a single backend instance can handle.
-
#max_rate ⇒ Fixnum
The max requests per second (RPS) of the group.
-
#max_rate_per_endpoint ⇒ Float
The max requests per second (RPS) that a single backend network endpoint can handle.
-
#max_rate_per_instance ⇒ Float
The max requests per second (RPS) that a single backend instance can handle.
-
#max_utilization ⇒ Float
Used when balancingMode is UTILIZATION.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Backend
constructor
A new instance of Backend.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Backend
Returns a new instance of Backend
2852 2853 2854 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2852 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
2749 2750 2751 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2749 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
2759 2760 2761 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2759 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
2765 2766 2767 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2765 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
2771 2772 2773 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2771 def failover @failover 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
2791 2792 2793 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2791 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
2799 2800 2801 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2799 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
2808 2809 2810 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2808 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
2817 2818 2819 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2817 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
2825 2826 2827 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2825 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
2834 2835 2836 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2834 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
2843 2844 2845 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2843 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
2850 2851 2852 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2850 def max_utilization @max_utilization end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2857 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 |