Reference documentation and code samples for the Compute V1 Client class AutoscalingPolicy.
Cloud Autoscaler policy.
Generated from protobuf message google.cloud.compute.v1.AutoscalingPolicy
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ cool_down_period_sec |
int
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. |
↳ cpu_utilization |
Google\Cloud\Compute\V1\AutoscalingPolicyCpuUtilization
Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. |
↳ custom_metric_utilizations |
array<Google\Cloud\Compute\V1\AutoscalingPolicyCustomMetricUtilization>
Configuration parameters of autoscaling based on a custom metric. |
↳ load_balancing_utilization |
Google\Cloud\Compute\V1\AutoscalingPolicyLoadBalancingUtilization
Configuration parameters of autoscaling based on load balancer. |
↳ max_num_replicas |
int
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. |
↳ min_num_replicas |
int
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. |
↳ mode |
string
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. |
↳ scale_in_control |
Google\Cloud\Compute\V1\AutoscalingPolicyScaleInControl
|
↳ scaling_schedules |
array|Google\Protobuf\Internal\MapField
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. |
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasCoolDownPeriodSec
clearCoolDownPeriodSec
setCoolDownPeriodSec
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCpuUtilization
Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\AutoscalingPolicyCpuUtilization|null |
|
hasCpuUtilization
clearCpuUtilization
setCpuUtilization
Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\AutoscalingPolicyCpuUtilization
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomMetricUtilizations
Configuration parameters of autoscaling based on a custom metric.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCustomMetricUtilizations
Configuration parameters of autoscaling based on a custom metric.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\AutoscalingPolicyCustomMetricUtilization>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoadBalancingUtilization
Configuration parameters of autoscaling based on load balancer.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\AutoscalingPolicyLoadBalancingUtilization|null |
|
hasLoadBalancingUtilization
clearLoadBalancingUtilization
setLoadBalancingUtilization
Configuration parameters of autoscaling based on load balancer.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\AutoscalingPolicyLoadBalancingUtilization
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMaxNumReplicas
clearMaxNumReplicas
setMaxNumReplicas
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMinNumReplicas
clearMinNumReplicas
setMinNumReplicas
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMode
clearMode
setMode
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScaleInControl
Generated from protobuf field optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\AutoscalingPolicyScaleInControl|null |
|
hasScaleInControl
clearScaleInControl
setScaleInControl
Generated from protobuf field optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\AutoscalingPolicyScaleInControl
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScalingSchedules
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setScalingSchedules
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|