Class AutomaticScaling (2.45.0)

public final class AutomaticScaling extends GeneratedMessageV3 implements AutomaticScalingOrBuilder

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

Protobuf type google.appengine.v1.AutomaticScaling

Static Fields

COOL_DOWN_PERIOD_FIELD_NUMBER

public static final int COOL_DOWN_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

CPU_UTILIZATION_FIELD_NUMBER

public static final int CPU_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

DISK_UTILIZATION_FIELD_NUMBER

public static final int DISK_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

MAX_CONCURRENT_REQUESTS_FIELD_NUMBER

public static final int MAX_CONCURRENT_REQUESTS_FIELD_NUMBER
Field Value
Type Description
int

MAX_IDLE_INSTANCES_FIELD_NUMBER

public static final int MAX_IDLE_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

MAX_PENDING_LATENCY_FIELD_NUMBER

public static final int MAX_PENDING_LATENCY_FIELD_NUMBER
Field Value
Type Description
int

MAX_TOTAL_INSTANCES_FIELD_NUMBER

public static final int MAX_TOTAL_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

MIN_IDLE_INSTANCES_FIELD_NUMBER

public static final int MIN_IDLE_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

MIN_PENDING_LATENCY_FIELD_NUMBER

public static final int MIN_PENDING_LATENCY_FIELD_NUMBER
Field Value
Type Description
int

MIN_TOTAL_INSTANCES_FIELD_NUMBER

public static final int MIN_TOTAL_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_UTILIZATION_FIELD_NUMBER

public static final int NETWORK_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_UTILIZATION_FIELD_NUMBER

public static final int REQUEST_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

STANDARD_SCHEDULER_SETTINGS_FIELD_NUMBER

public static final int STANDARD_SCHEDULER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutomaticScaling getDefaultInstance()
Returns
Type Description
AutomaticScaling

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AutomaticScaling.Builder newBuilder()
Returns
Type Description
AutomaticScaling.Builder

newBuilder(AutomaticScaling prototype)

public static AutomaticScaling.Builder newBuilder(AutomaticScaling prototype)
Parameter
Name Description
prototype AutomaticScaling
Returns
Type Description
AutomaticScaling.Builder

parseDelimitedFrom(InputStream input)

public static AutomaticScaling parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AutomaticScaling parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutomaticScaling parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutomaticScaling parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AutomaticScaling parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AutomaticScaling parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutomaticScaling parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomaticScaling
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AutomaticScaling> parser()
Returns
Type Description
Parser<AutomaticScaling>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCoolDownPeriod()

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

.google.protobuf.Duration cool_down_period = 1;

Returns
Type Description
Duration

The coolDownPeriod.

getCoolDownPeriodOrBuilder()

public DurationOrBuilder getCoolDownPeriodOrBuilder()

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.

.google.protobuf.Duration cool_down_period = 1;

Returns
Type Description
DurationOrBuilder

getCpuUtilization()

public CpuUtilization getCpuUtilization()

Target scaling by CPU usage.

.google.appengine.v1.CpuUtilization cpu_utilization = 2;

Returns
Type Description
CpuUtilization

The cpuUtilization.

getCpuUtilizationOrBuilder()

public CpuUtilizationOrBuilder getCpuUtilizationOrBuilder()

Target scaling by CPU usage.

.google.appengine.v1.CpuUtilization cpu_utilization = 2;

Returns
Type Description
CpuUtilizationOrBuilder

getDefaultInstanceForType()

public AutomaticScaling getDefaultInstanceForType()
Returns
Type Description
AutomaticScaling

getDiskUtilization()

public DiskUtilization getDiskUtilization()

Target scaling by disk usage.

.google.appengine.v1.DiskUtilization disk_utilization = 11;

Returns
Type Description
DiskUtilization

The diskUtilization.

getDiskUtilizationOrBuilder()

public DiskUtilizationOrBuilder getDiskUtilizationOrBuilder()

Target scaling by disk usage.

.google.appengine.v1.DiskUtilization disk_utilization = 11;

Returns
Type Description
DiskUtilizationOrBuilder

getMaxConcurrentRequests()

public int getMaxConcurrentRequests()

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

Defaults to a runtime-specific value.

int32 max_concurrent_requests = 3;

Returns
Type Description
int

The maxConcurrentRequests.

getMaxIdleInstances()

public int getMaxIdleInstances()

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

int32 max_idle_instances = 4;

Returns
Type Description
int

The maxIdleInstances.

getMaxPendingLatency()

public Duration getMaxPendingLatency()

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

.google.protobuf.Duration max_pending_latency = 6;

Returns
Type Description
Duration

The maxPendingLatency.

getMaxPendingLatencyOrBuilder()

public DurationOrBuilder getMaxPendingLatencyOrBuilder()

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

.google.protobuf.Duration max_pending_latency = 6;

Returns
Type Description
DurationOrBuilder

getMaxTotalInstances()

public int getMaxTotalInstances()

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

int32 max_total_instances = 5;

Returns
Type Description
int

The maxTotalInstances.

getMinIdleInstances()

public int getMinIdleInstances()

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

int32 min_idle_instances = 7;

Returns
Type Description
int

The minIdleInstances.

getMinPendingLatency()

public Duration getMinPendingLatency()

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

.google.protobuf.Duration min_pending_latency = 9;

Returns
Type Description
Duration

The minPendingLatency.

getMinPendingLatencyOrBuilder()

public DurationOrBuilder getMinPendingLatencyOrBuilder()

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

.google.protobuf.Duration min_pending_latency = 9;

Returns
Type Description
DurationOrBuilder

getMinTotalInstances()

public int getMinTotalInstances()

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

int32 min_total_instances = 8;

Returns
Type Description
int

The minTotalInstances.

getNetworkUtilization()

public NetworkUtilization getNetworkUtilization()

Target scaling by network usage.

.google.appengine.v1.NetworkUtilization network_utilization = 12;

Returns
Type Description
NetworkUtilization

The networkUtilization.

getNetworkUtilizationOrBuilder()

public NetworkUtilizationOrBuilder getNetworkUtilizationOrBuilder()

Target scaling by network usage.

.google.appengine.v1.NetworkUtilization network_utilization = 12;

Returns
Type Description
NetworkUtilizationOrBuilder

getParserForType()

public Parser<AutomaticScaling> getParserForType()
Returns
Type Description
Parser<AutomaticScaling>
Overrides

getRequestUtilization()

public RequestUtilization getRequestUtilization()

Target scaling by request utilization.

.google.appengine.v1.RequestUtilization request_utilization = 10;

Returns
Type Description
RequestUtilization

The requestUtilization.

getRequestUtilizationOrBuilder()

public RequestUtilizationOrBuilder getRequestUtilizationOrBuilder()

Target scaling by request utilization.

.google.appengine.v1.RequestUtilization request_utilization = 10;

Returns
Type Description
RequestUtilizationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStandardSchedulerSettings()

public StandardSchedulerSettings getStandardSchedulerSettings()

Scheduler settings for standard environment.

.google.appengine.v1.StandardSchedulerSettings standard_scheduler_settings = 20;

Returns
Type Description
StandardSchedulerSettings

The standardSchedulerSettings.

getStandardSchedulerSettingsOrBuilder()

public StandardSchedulerSettingsOrBuilder getStandardSchedulerSettingsOrBuilder()

Scheduler settings for standard environment.

.google.appengine.v1.StandardSchedulerSettings standard_scheduler_settings = 20;

Returns
Type Description
StandardSchedulerSettingsOrBuilder

hasCoolDownPeriod()

public boolean hasCoolDownPeriod()

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.

.google.protobuf.Duration cool_down_period = 1;

Returns
Type Description
boolean

Whether the coolDownPeriod field is set.

hasCpuUtilization()

public boolean hasCpuUtilization()

Target scaling by CPU usage.

.google.appengine.v1.CpuUtilization cpu_utilization = 2;

Returns
Type Description
boolean

Whether the cpuUtilization field is set.

hasDiskUtilization()

public boolean hasDiskUtilization()

Target scaling by disk usage.

.google.appengine.v1.DiskUtilization disk_utilization = 11;

Returns
Type Description
boolean

Whether the diskUtilization field is set.

hasMaxPendingLatency()

public boolean hasMaxPendingLatency()

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

.google.protobuf.Duration max_pending_latency = 6;

Returns
Type Description
boolean

Whether the maxPendingLatency field is set.

hasMinPendingLatency()

public boolean hasMinPendingLatency()

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

.google.protobuf.Duration min_pending_latency = 9;

Returns
Type Description
boolean

Whether the minPendingLatency field is set.

hasNetworkUtilization()

public boolean hasNetworkUtilization()

Target scaling by network usage.

.google.appengine.v1.NetworkUtilization network_utilization = 12;

Returns
Type Description
boolean

Whether the networkUtilization field is set.

hasRequestUtilization()

public boolean hasRequestUtilization()

Target scaling by request utilization.

.google.appengine.v1.RequestUtilization request_utilization = 10;

Returns
Type Description
boolean

Whether the requestUtilization field is set.

hasStandardSchedulerSettings()

public boolean hasStandardSchedulerSettings()

Scheduler settings for standard environment.

.google.appengine.v1.StandardSchedulerSettings standard_scheduler_settings = 20;

Returns
Type Description
boolean

Whether the standardSchedulerSettings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AutomaticScaling.Builder newBuilderForType()
Returns
Type Description
AutomaticScaling.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutomaticScaling.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AutomaticScaling.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AutomaticScaling.Builder toBuilder()
Returns
Type Description
AutomaticScaling.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException