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



1709
1710
1711
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1709

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:



1627
1628
1629
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1627

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) 


1632
1633
1634
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1632

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) 


1638
1639
1640
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1638

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) 


1644
1645
1646
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1644

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) 


1649
1650
1651
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1649

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) 


1659
1660
1661
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1659

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) 


1668
1669
1670
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1668

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) 


1674
1675
1676
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1674

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


1679
1680
1681
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1679

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) 


1684
1685
1686
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1684

def self_link_with_id
  @self_link_with_id
end

#status ⇒ String

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

Returns:

  • (String) 


1689
1690
1691
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1689

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:



1696
1697
1698
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1696

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) 


1701
1702
1703
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1701

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) 


1707
1708
1709
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1707

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1714

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