Class: Google::Apis::ComputeAlpha::Autoscaler
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Autoscaler
- 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. Google Compute Engine has two Autoscaler resources:
- Global * 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. (==
resource_for
$api_version
.autoscalers ==) (== resource_for$api_version
. regionAutoscalers ==)
Instance Attribute Summary collapse
-
#autoscaling_policy ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicy
Cloud Autoscaler policy.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#recommended_size ⇒ Fixnum
[Output Only] Target recommended MIG size (number of instances) computed by autoscaler.
-
#region ⇒ String
[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#status ⇒ String
[Output Only] The status of the autoscaler configuration.
-
#status_details ⇒ Array<Google::Apis::ComputeAlpha::AutoscalerStatusDetails>
[Output Only] Human-readable details about the current state of the autoscaler.
-
#target ⇒ String
URL of the managed instance group that this autoscaler will scale.
-
#zone ⇒ String
[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
Instance Method Summary collapse
-
#initialize(**args) ⇒ Autoscaler
constructor
A new instance of Autoscaler.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Autoscaler
Returns a new instance of Autoscaler.
1761 1762 1763 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1761 def initialize(**args) update!(**args) end |
Instance Attribute Details
#autoscaling_policy ⇒ Google::Apis::ComputeAlpha::AutoscalingPolicy
Cloud Autoscaler policy.
Corresponds to the JSON property autoscalingPolicy
1672 1673 1674 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1672 def autoscaling_policy @autoscaling_policy end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
1677 1678 1679 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1677 def @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
1683 1684 1685 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1683 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
1689 1690 1691 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1689 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
Corresponds to the JSON property kind
1694 1695 1696 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1694 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
1704 1705 1706 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1704 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
1713 1714 1715 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1713 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
1719 1720 1721 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1719 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
1724 1725 1726 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1724 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
1729 1730 1731 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1729 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
1741 1742 1743 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1741 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
1748 1749 1750 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1748 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
1753 1754 1755 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1753 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
1759 1760 1761 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1759 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 1766 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 |