Class: Google::Apis::ComputeAlpha::Autoscaler

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

Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * Zonal * Regional Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Autoscaler

Returns a new instance of Autoscaler.



2209
2210
2211
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2209

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

Instance Attribute Details

#autoscaling_policy ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicy

Cloud Autoscaler policy. Corresponds to the JSON property autoscalingPolicy

Returns:



2115
2116
2117
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2115

def autoscaling_policy
  @autoscaling_policy
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


2120
2121
2122
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2120

def creation_timestamp
  @creation_timestamp
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) 


2126
2127
2128
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2126

def description
  @description
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


2132
2133
2134
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2132

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers. Corresponds to the JSON property kind

Returns:

  • (String) 


2137
2138
2139
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2137

def kind
  @kind
end

#name ⇒ String

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a- z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


2147
2148
2149
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2147

def name
  @name
end

#recommended_size ⇒ Fixnum

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. Corresponds to the JSON property recommendedSize

Returns:

  • (Fixnum) 


2156
2157
2158
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2156

def recommended_size
  @recommended_size
end

#region ⇒ String

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). Corresponds to the JSON property region

Returns:

  • (String) 


2162
2163
2164
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2162

def region
  @region
end

#scaling_schedule_status ⇒ Hash<String,Google::Apis::ComputeAlpha::ScalingScheduleStatus>

[Output Only] Status information of existing scaling schedules. Corresponds to the JSON property scalingScheduleStatus

Returns:



2167
2168
2169
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2167

def scaling_schedule_status
  @scaling_schedule_status
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2172
2173
2174
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2172

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


2177
2178
2179
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2177

def self_link_with_id
  @self_link_with_id
end

#status ⇒ String

[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. Corresponds to the JSON property status

Returns:

  • (String) 


2188
2189
2190
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2188

def status
  @status
end

#status_details ⇒ Array<Google::Apis::ComputeAlpha::AutoscalerStatusDetails>

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. Corresponds to the JSON property statusDetails

Returns:



2195
2196
2197
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2195

def status_details
  @status_details
end

#target ⇒ String

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. Corresponds to the JSON property target

Returns:

  • (String) 


2201
2202
2203
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2201

def target
  @target
end

#zone ⇒ String

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). Corresponds to the JSON property zone

Returns:

  • (String) 


2207
2208
2209
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2207

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 2214

def update!(**args)
  @autoscaling_policy = args[:autoscaling_policy] if args.key?(:autoscaling_policy)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @recommended_size = args[:recommended_size] if args.key?(:recommended_size)
  @region = args[:region] if args.key?(:region)
  @scaling_schedule_status = args[:scaling_schedule_status] if args.key?(:scaling_schedule_status)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @status = args[:status] if args.key?(:status)
  @status_details = args[:status_details] if args.key?(:status_details)
  @target = args[:target] if args.key?(:target)
  @zone = args[:zone] if args.key?(:zone)
end