Class: Google::Apis::ComputeAlpha::AutoscalingPolicy

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

Cloud Autoscaler policy.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AutoscalingPolicy

Returns a new instance of AutoscalingPolicy.



2686
2687
2688
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2686

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

Instance Attribute Details

#cool_down_period_sec ⇒ Fixnum

The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process. Corresponds to the JSON property coolDownPeriodSec

Returns:

  • (Fixnum) 


2624
2625
2626
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2624

def cool_down_period_sec
  @cool_down_period_sec
end

#cpu_utilization ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicyCpuUtilization

CPU utilization policy. Corresponds to the JSON property cpuUtilization

Returns:



2629
2630
2631
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2629

def cpu_utilization
  @cpu_utilization
end

#custom_metric_utilizations ⇒ Array<Google::Apis::ComputeAlpha::AutoscalingPolicyCustomMetricUtilization>

Configuration parameters of autoscaling based on a custom metric. Corresponds to the JSON property customMetricUtilizations

Returns:



2634
2635
2636
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2634

def custom_metric_utilizations
  @custom_metric_utilizations
end

#load_balancing_utilization ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicyLoadBalancingUtilization

Configuration parameters of autoscaling based on load balancing. Corresponds to the JSON property loadBalancingUtilization

Returns:



2639
2640
2641
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2639

def load_balancing_utilization
  @load_balancing_utilization
end

#max_num_replicas ⇒ Fixnum

The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas. Corresponds to the JSON property maxNumReplicas

Returns:

  • (Fixnum) 


2646
2647
2648
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2646

def max_num_replicas
  @max_num_replicas
end

#min_num_replicas ⇒ Fixnum

The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed. Corresponds to the JSON property minNumReplicas

Returns:

  • (Fixnum) 


2653
2654
2655
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2653

def min_num_replicas
  @min_num_replicas
end

#mode ⇒ String

Defines the operating mode for this policy. The following modes are available:

  • OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler" Corresponds to the JSON property mode

Returns:

  • (String) 


2662
2663
2664
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2662

def mode
  @mode
end

#scale_down_control ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicyScaleDownControl

Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below. Corresponds to the JSON property scaleDownControl

Returns:



2669
2670
2671
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2669

def scale_down_control
  @scale_down_control
end

#scale_in_control ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicyScaleInControl

Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below. Corresponds to the JSON property scaleInControl

Returns:



2676
2677
2678
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2676

def scale_in_control
  @scale_in_control
end

#scaling_schedules ⇒ Hash<String,Google::Apis::ComputeAlpha::AutoscalingPolicyScalingSchedule>

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed. Corresponds to the JSON property scalingSchedules

Returns:



2684
2685
2686
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2684

def scaling_schedules
  @scaling_schedules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2691

def update!(**args)
  @cool_down_period_sec = args[:cool_down_period_sec] if args.key?(:cool_down_period_sec)
  @cpu_utilization = args[:cpu_utilization] if args.key?(:cpu_utilization)
  @custom_metric_utilizations = args[:custom_metric_utilizations] if args.key?(:custom_metric_utilizations)
  @load_balancing_utilization = args[:load_balancing_utilization] if args.key?(:load_balancing_utilization)
  @max_num_replicas = args[:max_num_replicas] if args.key?(:max_num_replicas)
  @min_num_replicas = args[:min_num_replicas] if args.key?(:min_num_replicas)
  @mode = args[:mode] if args.key?(:mode)
  @scale_down_control = args[:scale_down_control] if args.key?(:scale_down_control)
  @scale_in_control = args[:scale_in_control] if args.key?(:scale_in_control)
  @scaling_schedules = args[:scaling_schedules] if args.key?(:scaling_schedules)
end