- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface AutoscalingPolicyOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCoolDownPeriodSec()
public abstract int getCoolDownPeriodSec()The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.
optional int32 cool_down_period_sec = 107692954;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
int |
The minNumReplicas. |
getMode()
public abstract String getMode()Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler" Check the Mode enum for the list of possible values.
optional string mode = 3357091;
| Returns | |
|---|---|
| Type | Description |
String |
The mode. |
getModeBytes()
public abstract ByteString getModeBytes()Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler" Check the Mode enum for the list of possible values.
optional string mode = 3357091;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mode. |
getScaleInControl()
public abstract AutoscalingPolicyScaleInControl getScaleInControl()
optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
| Returns | |
|---|---|
| Type | Description |
AutoscalingPolicyScaleInControl |
The scaleInControl. |
getScaleInControlOrBuilder()
public abstract AutoscalingPolicyScaleInControlOrBuilder getScaleInControlOrBuilder()
optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
| Returns | |
|---|---|
| Type | Description |
AutoscalingPolicyScaleInControlOrBuilder |
|
getScalingSchedules() (deprecated)
public abstract Map<String,AutoscalingPolicyScalingSchedule> getScalingSchedules()Use #getScalingSchedulesMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
AutoscalingPolicyScalingSchedule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
AutoscalingPolicyScalingSchedule |
|
hasCoolDownPeriodSec()
public abstract boolean hasCoolDownPeriodSec()The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.
optional int32 cool_down_period_sec = 107692954;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the minNumReplicas field is set. |
hasMode()
public abstract boolean hasMode()Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler" Check the Mode enum for the list of possible values.
optional string mode = 3357091;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mode field is set. |
hasScaleInControl()
public abstract boolean hasScaleInControl()
optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the scaleInControl field is set. |