Google Cloud Appengine Admin V1 Client - Class AutomaticScaling (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class AutomaticScaling.

Automatic scaling is based on request rate, response latencies, and other application metrics.

Generated from protobuf message google.appengine.v1.AutomaticScaling

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ cool_down_period Google\Protobuf\Duration

The time period that the Autoscaler should wait 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. Only applicable in the App Engine flexible environment.
↳ cpu_utilization Google\Cloud\AppEngine\V1\CpuUtilization

Target scaling by CPU usage.
↳ max_concurrent_requests int

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
↳ max_idle_instances int

Maximum number of idle instances that should be maintained for this version.
↳ max_total_instances int

Maximum number of instances that should be started to handle requests for this version.
↳ max_pending_latency Google\Protobuf\Duration

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
↳ min_idle_instances int

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
↳ min_total_instances int

Minimum number of running instances that should be maintained for this version.
↳ min_pending_latency Google\Protobuf\Duration

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
↳ request_utilization Google\Cloud\AppEngine\V1\RequestUtilization

Target scaling by request utilization.
↳ disk_utilization Google\Cloud\AppEngine\V1\DiskUtilization

Target scaling by disk usage.
↳ network_utilization Google\Cloud\AppEngine\V1\NetworkUtilization

Target scaling by network usage.
↳ standard_scheduler_settings Google\Cloud\AppEngine\V1\StandardSchedulerSettings

Scheduler settings for standard environment.

getCoolDownPeriod

The time period that the Autoscaler should wait 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. Only applicable in the App Engine flexible environment.

Returns
Type Description
Google\Protobuf\Duration|null

hasCoolDownPeriod

clearCoolDownPeriod

setCoolDownPeriod

The time period that the Autoscaler should wait 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. Only applicable in the App Engine flexible environment.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getCpuUtilization

Target scaling by CPU usage.

Returns
Type Description
Google\Cloud\AppEngine\V1\CpuUtilization|null

hasCpuUtilization

clearCpuUtilization

setCpuUtilization

Target scaling by CPU usage.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\CpuUtilization
Returns
Type Description
$this

getMaxConcurrentRequests

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.

Defaults to a runtime-specific value.

Returns
Type Description
int

setMaxConcurrentRequests

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.

Defaults to a runtime-specific value.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxIdleInstances

Maximum number of idle instances that should be maintained for this version.

Returns
Type Description
int

setMaxIdleInstances

Maximum number of idle instances that should be maintained for this version.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxTotalInstances

Maximum number of instances that should be started to handle requests for this version.

Returns
Type Description
int

setMaxTotalInstances

Maximum number of instances that should be started to handle requests for this version.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxPendingLatency

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxPendingLatency

clearMaxPendingLatency

setMaxPendingLatency

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getMinIdleInstances

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.

Returns
Type Description
int

setMinIdleInstances

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.

Parameter
Name Description
var int
Returns
Type Description
$this

getMinTotalInstances

Minimum number of running instances that should be maintained for this version.

Returns
Type Description
int

setMinTotalInstances

Minimum number of running instances that should be maintained for this version.

Parameter
Name Description
var int
Returns
Type Description
$this

getMinPendingLatency

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.

Returns
Type Description
Google\Protobuf\Duration|null

hasMinPendingLatency

clearMinPendingLatency

setMinPendingLatency

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getRequestUtilization

Target scaling by request utilization.

Returns
Type Description
Google\Cloud\AppEngine\V1\RequestUtilization|null

hasRequestUtilization

clearRequestUtilization

setRequestUtilization

Target scaling by request utilization.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\RequestUtilization
Returns
Type Description
$this

getDiskUtilization

Target scaling by disk usage.

Returns
Type Description
Google\Cloud\AppEngine\V1\DiskUtilization|null

hasDiskUtilization

clearDiskUtilization

setDiskUtilization

Target scaling by disk usage.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\DiskUtilization
Returns
Type Description
$this

getNetworkUtilization

Target scaling by network usage.

Returns
Type Description
Google\Cloud\AppEngine\V1\NetworkUtilization|null

hasNetworkUtilization

clearNetworkUtilization

setNetworkUtilization

Target scaling by network usage.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\NetworkUtilization
Returns
Type Description
$this

getStandardSchedulerSettings

Scheduler settings for standard environment.

Returns
Type Description
Google\Cloud\AppEngine\V1\StandardSchedulerSettings|null

hasStandardSchedulerSettings

clearStandardSchedulerSettings

setStandardSchedulerSettings

Scheduler settings for standard environment.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\StandardSchedulerSettings
Returns
Type Description
$this