Class: Google::Apis::ComputeV1::AutoscalingPolicy

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



2170
2171
2172
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2170

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

Instance Attribute Details

#cool_down_period_sec ⇒ Fixnum

The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. Corresponds to the JSON property coolDownPeriodSec

Returns:

  • (Fixnum) 


2119
2120
2121
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2119

def cool_down_period_sec
  @cool_down_period_sec
end

#cpu_utilization ⇒ Google::Apis::ComputeV1::AutoscalingPolicyCpuUtilization

CPU utilization policy. Corresponds to the JSON property cpuUtilization

Returns:



2124
2125
2126
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2124

def cpu_utilization
  @cpu_utilization
end

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

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

Returns:



2129
2130
2131
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2129

def custom_metric_utilizations
  @custom_metric_utilizations
end

#load_balancing_utilization ⇒ Google::Apis::ComputeV1::AutoscalingPolicyLoadBalancingUtilization

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

Returns:



2134
2135
2136
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2134

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) 


2141
2142
2143
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2141

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) 


2148
2149
2150
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2148

def min_num_replicas
  @min_num_replicas
end

#mode ⇒ String

Defines operating mode for this policy. Corresponds to the JSON property mode

Returns:

  • (String) 


2153
2154
2155
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2153

def mode
  @mode
end

#scale_in_control ⇒ Google::Apis::ComputeV1::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:



2160
2161
2162
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2160

def scale_in_control
  @scale_in_control
end

#scaling_schedules ⇒ Hash<String,Google::Apis::ComputeV1::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:



2168
2169
2170
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2168

def scaling_schedules
  @scaling_schedules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2175

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