Class Autoscaler.Builder (1.22.0)

public static final class Autoscaler.Builder extends GeneratedMessageV3.Builder<Autoscaler.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllStatusDetails(Iterable<? extends AutoscalerStatusDetails> values)

public Autoscaler.Builder addAllStatusDetails(Iterable<? extends AutoscalerStatusDetails> values)

[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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.AutoscalerStatusDetails>
Returns
TypeDescription
Autoscaler.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Autoscaler.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Autoscaler.Builder
Overrides

addStatusDetails(AutoscalerStatusDetails value)

public Autoscaler.Builder addStatusDetails(AutoscalerStatusDetails value)

[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
NameDescription
valueAutoscalerStatusDetails
Returns
TypeDescription
Autoscaler.Builder

addStatusDetails(AutoscalerStatusDetails.Builder builderForValue)

public Autoscaler.Builder addStatusDetails(AutoscalerStatusDetails.Builder builderForValue)

[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
NameDescription
builderForValueAutoscalerStatusDetails.Builder
Returns
TypeDescription
Autoscaler.Builder

addStatusDetails(int index, AutoscalerStatusDetails value)

public Autoscaler.Builder addStatusDetails(int index, AutoscalerStatusDetails value)

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

Parameters
NameDescription
indexint
valueAutoscalerStatusDetails
Returns
TypeDescription
Autoscaler.Builder

addStatusDetails(int index, AutoscalerStatusDetails.Builder builderForValue)

public Autoscaler.Builder addStatusDetails(int index, AutoscalerStatusDetails.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueAutoscalerStatusDetails.Builder
Returns
TypeDescription
Autoscaler.Builder

addStatusDetailsBuilder()

public AutoscalerStatusDetails.Builder addStatusDetailsBuilder()

[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
TypeDescription
AutoscalerStatusDetails.Builder

addStatusDetailsBuilder(int index)

public AutoscalerStatusDetails.Builder addStatusDetailsBuilder(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
NameDescription
indexint
Returns
TypeDescription
AutoscalerStatusDetails.Builder

build()

public Autoscaler build()
Returns
TypeDescription
Autoscaler

buildPartial()

public Autoscaler buildPartial()
Returns
TypeDescription
Autoscaler

clear()

public Autoscaler.Builder clear()
Returns
TypeDescription
Autoscaler.Builder
Overrides

clearAutoscalingPolicy()

public Autoscaler.Builder clearAutoscalingPolicy()

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
TypeDescription
Autoscaler.Builder

clearCreationTimestamp()

public Autoscaler.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearDescription()

public Autoscaler.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Autoscaler.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Autoscaler.Builder
Overrides

clearId()

public Autoscaler.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearKind()

public Autoscaler.Builder clearKind()

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

optional string kind = 3292052;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearName()

public Autoscaler.Builder clearName()

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
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Autoscaler.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Autoscaler.Builder
Overrides

clearRecommendedSize()

public Autoscaler.Builder clearRecommendedSize()

[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
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearRegion()

public Autoscaler.Builder clearRegion()

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

optional string region = 138946292;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearScalingScheduleStatus()

public Autoscaler.Builder clearScalingScheduleStatus()
Returns
TypeDescription
Autoscaler.Builder
public Autoscaler.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearStatus()

public Autoscaler.Builder clearStatus()

[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
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearStatusDetails()

public Autoscaler.Builder clearStatusDetails()

[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
TypeDescription
Autoscaler.Builder

clearTarget()

public Autoscaler.Builder clearTarget()

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

optional string target = 192835985;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clearZone()

public Autoscaler.Builder clearZone()

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

optional string zone = 3744684;

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

clone()

public Autoscaler.Builder clone()
Returns
TypeDescription
Autoscaler.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

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
TypeDescription
AutoscalingPolicy

The autoscalingPolicy.

getAutoscalingPolicyBuilder()

public AutoscalingPolicy.Builder getAutoscalingPolicyBuilder()

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
TypeDescription
AutoscalingPolicy.Builder

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
TypeDescription
AutoscalingPolicyOrBuilder

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Autoscaler getDefaultInstanceForType()
Returns
TypeDescription
Autoscaler

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getMutableScalingScheduleStatus()

public Map<String,ScalingScheduleStatus> getMutableScalingScheduleStatus()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,ScalingScheduleStatus>

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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for region.

getScalingScheduleStatus()

public Map<String,ScalingScheduleStatus> getScalingScheduleStatus()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueScalingScheduleStatus
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
ScalingScheduleStatus
public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
AutoscalerStatusDetails

getStatusDetailsBuilder(int index)

public AutoscalerStatusDetails.Builder getStatusDetailsBuilder(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
NameDescription
indexint
Returns
TypeDescription
AutoscalerStatusDetails.Builder

getStatusDetailsBuilderList()

public List<AutoscalerStatusDetails.Builder> getStatusDetailsBuilderList()

[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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the zone field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAutoscalingPolicy(AutoscalingPolicy value)

public Autoscaler.Builder mergeAutoscalingPolicy(AutoscalingPolicy value)

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;

Parameter
NameDescription
valueAutoscalingPolicy
Returns
TypeDescription
Autoscaler.Builder

mergeFrom(Autoscaler other)

public Autoscaler.Builder mergeFrom(Autoscaler other)
Parameter
NameDescription
otherAutoscaler
Returns
TypeDescription
Autoscaler.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Autoscaler.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Autoscaler.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Autoscaler.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Autoscaler.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Autoscaler.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Autoscaler.Builder
Overrides

putAllScalingScheduleStatus(Map<String,ScalingScheduleStatus> values)

public Autoscaler.Builder putAllScalingScheduleStatus(Map<String,ScalingScheduleStatus> values)

[Output Only] Status information of existing scaling schedules.

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

Parameter
NameDescription
valuesMap<String,ScalingScheduleStatus>
Returns
TypeDescription
Autoscaler.Builder

putScalingScheduleStatus(String key, ScalingScheduleStatus value)

public Autoscaler.Builder putScalingScheduleStatus(String key, ScalingScheduleStatus value)

[Output Only] Status information of existing scaling schedules.

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

Parameters
NameDescription
keyString
valueScalingScheduleStatus
Returns
TypeDescription
Autoscaler.Builder

removeScalingScheduleStatus(String key)

public Autoscaler.Builder removeScalingScheduleStatus(String key)

[Output Only] Status information of existing scaling schedules.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Autoscaler.Builder

removeStatusDetails(int index)

public Autoscaler.Builder removeStatusDetails(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
NameDescription
indexint
Returns
TypeDescription
Autoscaler.Builder

setAutoscalingPolicy(AutoscalingPolicy value)

public Autoscaler.Builder setAutoscalingPolicy(AutoscalingPolicy value)

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;

Parameter
NameDescription
valueAutoscalingPolicy
Returns
TypeDescription
Autoscaler.Builder

setAutoscalingPolicy(AutoscalingPolicy.Builder builderForValue)

public Autoscaler.Builder setAutoscalingPolicy(AutoscalingPolicy.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueAutoscalingPolicy.Builder
Returns
TypeDescription
Autoscaler.Builder

setCreationTimestamp(String value)

public Autoscaler.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Autoscaler.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setDescription(String value)

public Autoscaler.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Autoscaler.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Autoscaler.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Autoscaler.Builder
Overrides

setId(long value)

public Autoscaler.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setKind(String value)

public Autoscaler.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Autoscaler.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setName(String value)

public Autoscaler.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Autoscaler.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setRecommendedSize(int value)

public Autoscaler.Builder setRecommendedSize(int value)

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

Parameter
NameDescription
valueint

The recommendedSize to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setRegion(String value)

public Autoscaler.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public Autoscaler.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Autoscaler.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Autoscaler.Builder
Overrides
public Autoscaler.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Autoscaler.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setStatus(String value)

public Autoscaler.Builder setStatus(String 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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
NameDescription
valueString

The status to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setStatusBytes(ByteString value)

public Autoscaler.Builder setStatusBytes(ByteString 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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
NameDescription
valueByteString

The bytes for status to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setStatusDetails(int index, AutoscalerStatusDetails value)

public Autoscaler.Builder setStatusDetails(int index, AutoscalerStatusDetails value)

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

Parameters
NameDescription
indexint
valueAutoscalerStatusDetails
Returns
TypeDescription
Autoscaler.Builder

setStatusDetails(int index, AutoscalerStatusDetails.Builder builderForValue)

public Autoscaler.Builder setStatusDetails(int index, AutoscalerStatusDetails.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueAutoscalerStatusDetails.Builder
Returns
TypeDescription
Autoscaler.Builder

setTarget(String value)

public Autoscaler.Builder setTarget(String value)

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

optional string target = 192835985;

Parameter
NameDescription
valueString

The target to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public Autoscaler.Builder setTargetBytes(ByteString value)

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

optional string target = 192835985;

Parameter
NameDescription
valueByteString

The bytes for target to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Autoscaler.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Autoscaler.Builder
Overrides

setZone(String value)

public Autoscaler.Builder setZone(String value)

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

optional string zone = 3744684;

Parameter
NameDescription
valueString

The zone to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public Autoscaler.Builder setZoneBytes(ByteString value)

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

optional string zone = 3744684;

Parameter
NameDescription
valueByteString

The bytes for zone to set.

Returns
TypeDescription
Autoscaler.Builder

This builder for chaining.