Interface AutoscalerOrBuilder (1.18.0)

public interface AutoscalerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsScalingScheduleStatus(String key)

public abstract 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 abstract 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.

getAutoscalingPolicyOrBuilder()

public abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract 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 abstract 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.

getId()

public abstract 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 abstract String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,ScalingScheduleStatus> getScalingScheduleStatus()
Returns
TypeDescription
Map<String,ScalingScheduleStatus>

getScalingScheduleStatusCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getStatus()

public abstract 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 abstract 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 abstract 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

getStatusDetailsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.