Interface AutoscalingPolicyOrBuilder (1.18.0)

public interface AutoscalingPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsScalingSchedules(String key)

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

getCoolDownPeriodSec()

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

getLoadBalancingUtilization()

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

getScaleInControl()

public abstract AutoscalingPolicyScaleInControl getScaleInControl()

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

Returns
TypeDescription
AutoscalingPolicyScaleInControl

The scaleInControl.

getScaleInControlOrBuilder()

public abstract AutoscalingPolicyScaleInControlOrBuilder getScaleInControlOrBuilder()

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

Returns
TypeDescription
AutoscalingPolicyScaleInControlOrBuilder

getScalingSchedules()

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

getScalingSchedulesCount()

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

hasCoolDownPeriodSec()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasScaleInControl()

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

Returns
TypeDescription
boolean

Whether the scaleInControl field is set.