Class Autoscaler (1.54.0)

public final class Autoscaler extends GeneratedMessageV3 implements AutoscalerOrBuilder

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.

Protobuf type google.cloud.compute.v1.Autoscaler

Implements

AutoscalerOrBuilder

Static Fields

AUTOSCALING_POLICY_FIELD_NUMBER

public static final int AUTOSCALING_POLICY_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int RECOMMENDED_SIZE_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

SCALING_SCHEDULE_STATUS_FIELD_NUMBER

public static final int SCALING_SCHEDULE_STATUS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

STATUS_DETAILS_FIELD_NUMBER

public static final int STATUS_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Autoscaler getDefaultInstance()
Returns
Type Description
Autoscaler

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Autoscaler.Builder newBuilder()
Returns
Type Description
Autoscaler.Builder

newBuilder(Autoscaler prototype)

public static Autoscaler.Builder newBuilder(Autoscaler prototype)
Parameter
Name Description
prototype Autoscaler
Returns
Type Description
Autoscaler.Builder

parseDelimitedFrom(InputStream input)

public static Autoscaler parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Autoscaler parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Autoscaler parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Autoscaler parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Autoscaler parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Autoscaler parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Autoscaler parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Autoscaler
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Autoscaler> parser()
Returns
Type Description
Parser<Autoscaler>

Methods

containsScalingScheduleStatus(String key)

public boolean containsScalingScheduleStatus(String key)

[Output Only] Status information of existing scaling schedules.

map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoscalingPolicy()

public AutoscalingPolicy getAutoscalingPolicy()

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

optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;

Returns
Type Description
AutoscalingPolicy

The autoscalingPolicy.

getAutoscalingPolicyOrBuilder()

public AutoscalingPolicyOrBuilder getAutoscalingPolicyOrBuilder()

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

optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;

Returns
Type Description
AutoscalingPolicyOrBuilder

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Autoscaler getDefaultInstanceForType()
Returns
Type Description
Autoscaler

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Autoscaler> getParserForType()
Returns
Type Description
Parser<Autoscaler>
Overrides

getRecommendedSize()

public int getRecommendedSize()

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

optional int32 recommended_size = 257915749;

Returns
Type Description
int

The recommendedSize.

getRegion()

public String getRegion()

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

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getScalingScheduleStatus() (deprecated)

public Map<String,ScalingScheduleStatus> getScalingScheduleStatus()
Returns
Type Description
Map<String,ScalingScheduleStatus>

getScalingScheduleStatusCount()

public int getScalingScheduleStatusCount()

[Output Only] Status information of existing scaling schedules.

map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;

Returns
Type Description
int

getScalingScheduleStatusMap()

public Map<String,ScalingScheduleStatus> getScalingScheduleStatusMap()

[Output Only] Status information of existing scaling schedules.

map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;

Returns
Type Description
Map<String,ScalingScheduleStatus>

getScalingScheduleStatusOrDefault(String key, ScalingScheduleStatus defaultValue)

public ScalingScheduleStatus getScalingScheduleStatusOrDefault(String key, ScalingScheduleStatus defaultValue)

[Output Only] Status information of existing scaling schedules.

map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;

Parameters
Name Description
key String
defaultValue ScalingScheduleStatus
Returns
Type Description
ScalingScheduleStatus

getScalingScheduleStatusOrThrow(String key)

public ScalingScheduleStatus getScalingScheduleStatusOrThrow(String key)

[Output Only] Status information of existing scaling schedules.

map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;

Parameter
Name Description
key String
Returns
Type Description
ScalingScheduleStatus
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public String getStatus()

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

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

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

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getStatusDetails(int index)

public AutoscalerStatusDetails getStatusDetails(int index)

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

repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;

Parameter
Name Description
index int
Returns
Type Description
AutoscalerStatusDetails

getStatusDetailsCount()

public int getStatusDetailsCount()

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

repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;

Returns
Type Description
int

getStatusDetailsList()

public List<AutoscalerStatusDetails> getStatusDetailsList()

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

repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;

Returns
Type Description
List<AutoscalerStatusDetails>

getStatusDetailsOrBuilder(int index)

public AutoscalerStatusDetailsOrBuilder getStatusDetailsOrBuilder(int index)

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

repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;

Parameter
Name Description
index int
Returns
Type Description
AutoscalerStatusDetailsOrBuilder

getStatusDetailsOrBuilderList()

public List<? extends AutoscalerStatusDetailsOrBuilder> getStatusDetailsOrBuilderList()

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

repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.AutoscalerStatusDetailsOrBuilder>

getTarget()

public String getTarget()

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.

optional string target = 192835985;

Returns
Type Description
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.

optional string target = 192835985;

Returns
Type Description
ByteString

The bytes for target.

getZone()

public String getZone()

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

optional string zone = 3744684;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

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

optional string zone = 3744684;

Returns
Type Description
ByteString

The bytes for zone.

hasAutoscalingPolicy()

public boolean hasAutoscalingPolicy()

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

optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;

Returns
Type Description
boolean

Whether the autoscalingPolicy field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasRecommendedSize()

public boolean hasRecommendedSize()

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

optional int32 recommended_size = 257915749;

Returns
Type Description
boolean

Whether the recommendedSize field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasStatus()

public boolean hasStatus()

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

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasTarget()

public boolean hasTarget()

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.

optional string target = 192835985;

Returns
Type Description
boolean

Whether the target field is set.

hasZone()

public boolean hasZone()

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

optional string zone = 3744684;

Returns
Type Description
boolean

Whether the zone field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Autoscaler.Builder newBuilderForType()
Returns
Type Description
Autoscaler.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Autoscaler.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Autoscaler.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Autoscaler.Builder toBuilder()
Returns
Type Description
Autoscaler.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException