Class Autoscaler (1.5.0)

Version 1.5.0

• 1.20.1 (latest)
• 1.20.0
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

Autoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * Zonal </compute/docs/reference/rest/v1/autoscalers> * Regional </compute/docs/reference/rest/v1/regionAutoscalers> 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.

Attributes

Name	Description
autoscaling_policy	google.cloud.compute_v1.types.AutoscalingPolicy The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. This field is a member of `oneof`_ ``_autoscaling_policy``.
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ ``_creation_timestamp``.
description	str An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ ``_description``.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ ``_id``.
kind	str [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. This field is a member of `oneof`_ ``_kind``.
name	str 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. This field is a member of `oneof`_ ``_name``.
recommended_size	int [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. This field is a member of `oneof`_ ``_recommended_size``.
region	str [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). This field is a member of `oneof`_ ``_region``.
scaling_schedule_status	Mapping[str, google.cloud.compute_v1.types.ScalingScheduleStatus] [Output Only] Status information of existing scaling schedules.
self_link	str [Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ ``_self_link``.
status	str [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. Check the Status enum for the list of possible values. This field is a member of `oneof`_ ``_status``.
status_details	Sequence[google.cloud.compute_v1.types.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.
target	str URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. This field is a member of `oneof`_ ``_target``.
zone	str [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). This field is a member of `oneof`_ ``_zone``.

Inheritance

builtins.object > proto.message.Message > Autoscaler

Classes

ScalingScheduleStatusEntry

ScalingScheduleStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Status

Status(value)

[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.