Class AutoscalingPolicy (1.14.0)

public final class AutoscalingPolicy extends GeneratedMessageV3 implements AutoscalingPolicyOrBuilder

Cloud Autoscaler policy.

Protobuf type google.cloud.compute.v1.AutoscalingPolicy

Static Fields

COOL_DOWN_PERIOD_SEC_FIELD_NUMBER

public static final int COOL_DOWN_PERIOD_SEC_FIELD_NUMBER
Field Value
TypeDescription
int

CPU_UTILIZATION_FIELD_NUMBER

public static final int CPU_UTILIZATION_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_METRIC_UTILIZATIONS_FIELD_NUMBER

public static final int CUSTOM_METRIC_UTILIZATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LOAD_BALANCING_UTILIZATION_FIELD_NUMBER

public static final int LOAD_BALANCING_UTILIZATION_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_NUM_REPLICAS_FIELD_NUMBER

public static final int MAX_NUM_REPLICAS_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_NUM_REPLICAS_FIELD_NUMBER

public static final int MIN_NUM_REPLICAS_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_IN_CONTROL_FIELD_NUMBER

public static final int SCALE_IN_CONTROL_FIELD_NUMBER
Field Value
TypeDescription
int

SCALING_SCHEDULES_FIELD_NUMBER

public static final int SCALING_SCHEDULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AutoscalingPolicy getDefaultInstance()
Returns
TypeDescription
AutoscalingPolicy

getDescriptor()

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

newBuilder()

public static AutoscalingPolicy.Builder newBuilder()
Returns
TypeDescription
AutoscalingPolicy.Builder

newBuilder(AutoscalingPolicy prototype)

public static AutoscalingPolicy.Builder newBuilder(AutoscalingPolicy prototype)
Parameter
NameDescription
prototypeAutoscalingPolicy
Returns
TypeDescription
AutoscalingPolicy.Builder

parseDelimitedFrom(InputStream input)

public static AutoscalingPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AutoscalingPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutoscalingPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutoscalingPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AutoscalingPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AutoscalingPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AutoscalingPolicy> parser()
Returns
TypeDescription
Parser<AutoscalingPolicy>

Methods

containsScalingSchedules(String key)

public boolean containsScalingSchedules(String key)

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCoolDownPeriodSec()

public int getCoolDownPeriodSec()

The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

optional int32 cool_down_period_sec = 107692954;

Returns
TypeDescription
int

The coolDownPeriodSec.

getCpuUtilization()

public AutoscalingPolicyCpuUtilization getCpuUtilization()

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;

Returns
TypeDescription
AutoscalingPolicyCpuUtilization

The cpuUtilization.

getCpuUtilizationOrBuilder()

public AutoscalingPolicyCpuUtilizationOrBuilder getCpuUtilizationOrBuilder()

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;

Returns
TypeDescription
AutoscalingPolicyCpuUtilizationOrBuilder

getCustomMetricUtilizations(int index)

public AutoscalingPolicyCustomMetricUtilization getCustomMetricUtilizations(int index)

Configuration parameters of autoscaling based on a custom metric.

repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

Parameter
NameDescription
indexint
Returns
TypeDescription
AutoscalingPolicyCustomMetricUtilization

getCustomMetricUtilizationsCount()

public int getCustomMetricUtilizationsCount()

Configuration parameters of autoscaling based on a custom metric.

repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

Returns
TypeDescription
int

getCustomMetricUtilizationsList()

public List<AutoscalingPolicyCustomMetricUtilization> getCustomMetricUtilizationsList()

Configuration parameters of autoscaling based on a custom metric.

repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

Returns
TypeDescription
List<AutoscalingPolicyCustomMetricUtilization>

getCustomMetricUtilizationsOrBuilder(int index)

public AutoscalingPolicyCustomMetricUtilizationOrBuilder getCustomMetricUtilizationsOrBuilder(int index)

Configuration parameters of autoscaling based on a custom metric.

repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

Parameter
NameDescription
indexint
Returns
TypeDescription
AutoscalingPolicyCustomMetricUtilizationOrBuilder

getCustomMetricUtilizationsOrBuilderList()

public List<? extends AutoscalingPolicyCustomMetricUtilizationOrBuilder> getCustomMetricUtilizationsOrBuilderList()

Configuration parameters of autoscaling based on a custom metric.

repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilizationOrBuilder>

getDefaultInstanceForType()

public AutoscalingPolicy getDefaultInstanceForType()
Returns
TypeDescription
AutoscalingPolicy

getLoadBalancingUtilization()

public AutoscalingPolicyLoadBalancingUtilization getLoadBalancingUtilization()

Configuration parameters of autoscaling based on load balancer.

optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;

Returns
TypeDescription
AutoscalingPolicyLoadBalancingUtilization

The loadBalancingUtilization.

getLoadBalancingUtilizationOrBuilder()

public AutoscalingPolicyLoadBalancingUtilizationOrBuilder getLoadBalancingUtilizationOrBuilder()

Configuration parameters of autoscaling based on load balancer.

optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;

Returns
TypeDescription
AutoscalingPolicyLoadBalancingUtilizationOrBuilder

getMaxNumReplicas()

public int getMaxNumReplicas()

The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.

optional int32 max_num_replicas = 62327375;

Returns
TypeDescription
int

The maxNumReplicas.

getMinNumReplicas()

public int getMinNumReplicas()

The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.

optional int32 min_num_replicas = 535329825;

Returns
TypeDescription
int

The minNumReplicas.

getMode()

public String getMode()

Defines operating mode for this policy. Check the Mode enum for the list of possible values.

optional string mode = 3357091;

Returns
TypeDescription
String

The mode.

getModeBytes()

public ByteString getModeBytes()

Defines operating mode for this policy. Check the Mode enum for the list of possible values.

optional string mode = 3357091;

Returns
TypeDescription
ByteString

The bytes for mode.

getParserForType()

public Parser<AutoscalingPolicy> getParserForType()
Returns
TypeDescription
Parser<AutoscalingPolicy>
Overrides

getScaleInControl()

public AutoscalingPolicyScaleInControl getScaleInControl()

optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;

Returns
TypeDescription
AutoscalingPolicyScaleInControl

The scaleInControl.

getScaleInControlOrBuilder()

public AutoscalingPolicyScaleInControlOrBuilder getScaleInControlOrBuilder()

optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;

Returns
TypeDescription
AutoscalingPolicyScaleInControlOrBuilder

getScalingSchedules()

public Map<String,AutoscalingPolicyScalingSchedule> getScalingSchedules()
Returns
TypeDescription
Map<String,AutoscalingPolicyScalingSchedule>

getScalingSchedulesCount()

public int getScalingSchedulesCount()

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;

Returns
TypeDescription
int

getScalingSchedulesMap()

public Map<String,AutoscalingPolicyScalingSchedule> getScalingSchedulesMap()

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;

Returns
TypeDescription
Map<String,AutoscalingPolicyScalingSchedule>

getScalingSchedulesOrDefault(String key, AutoscalingPolicyScalingSchedule defaultValue)

public AutoscalingPolicyScalingSchedule getScalingSchedulesOrDefault(String key, AutoscalingPolicyScalingSchedule defaultValue)

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;

Parameters
NameDescription
keyString
defaultValueAutoscalingPolicyScalingSchedule
Returns
TypeDescription
AutoscalingPolicyScalingSchedule

getScalingSchedulesOrThrow(String key)

public AutoscalingPolicyScalingSchedule getScalingSchedulesOrThrow(String key)

Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.

map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;

Parameter
NameDescription
keyString
Returns
TypeDescription
AutoscalingPolicyScalingSchedule

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCoolDownPeriodSec()

public boolean hasCoolDownPeriodSec()

The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

optional int32 cool_down_period_sec = 107692954;

Returns
TypeDescription
boolean

Whether the coolDownPeriodSec field is set.

hasCpuUtilization()

public boolean hasCpuUtilization()

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;

Returns
TypeDescription
boolean

Whether the cpuUtilization field is set.

hasLoadBalancingUtilization()

public boolean hasLoadBalancingUtilization()

Configuration parameters of autoscaling based on load balancer.

optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;

Returns
TypeDescription
boolean

Whether the loadBalancingUtilization field is set.

hasMaxNumReplicas()

public boolean hasMaxNumReplicas()

The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.

optional int32 max_num_replicas = 62327375;

Returns
TypeDescription
boolean

Whether the maxNumReplicas field is set.

hasMinNumReplicas()

public boolean hasMinNumReplicas()

The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.

optional int32 min_num_replicas = 535329825;

Returns
TypeDescription
boolean

Whether the minNumReplicas field is set.

hasMode()

public boolean hasMode()

Defines operating mode for this policy. Check the Mode enum for the list of possible values.

optional string mode = 3357091;

Returns
TypeDescription
boolean

Whether the mode field is set.

hasScaleInControl()

public boolean hasScaleInControl()

optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;

Returns
TypeDescription
boolean

Whether the scaleInControl field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AutoscalingPolicy.Builder newBuilderForType()
Returns
TypeDescription
AutoscalingPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutoscalingPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AutoscalingPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AutoscalingPolicy.Builder toBuilder()
Returns
TypeDescription
AutoscalingPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException