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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb

Overview

Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1. autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Autoscaler

Returns a new instance of Autoscaler



2065
2066
2067
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2065

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:



1988
1989
1990
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1988

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) 


1993
1994
1995
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1993

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) 


1999
2000
2001
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1999

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) 


2005
2006
2007
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2005

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) 


2010
2011
2012
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2010

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) 


2020
2021
2022
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2020

def name
  @name
end

#recommended_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2029
2030
2031
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2029

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) 


2035
2036
2037
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2035

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


2040
2041
2042
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2040

def self_link
  @self_link
end

#status ⇒ String

[Output Only] The status of the autoscaler configuration. Corresponds to the JSON property status

Returns:

  • (String) 


2045
2046
2047
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2045

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:



2052
2053
2054
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2052

def status_details
  @status_details
end

#target ⇒ String

URL of the managed instance group that this autoscaler will scale. Corresponds to the JSON property target

Returns:

  • (String) 


2057
2058
2059
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2057

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) 


2063
2064
2065
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2063

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 2070

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