com.google.api.services.compute.model

Class AutoscalingPolicyCpuUtilization

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.AutoscalingPolicyCpuUtilization

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AutoscalingPolicyCpuUtilization
extends com.google.api.client.json.GenericJson

CPU utilization policy.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AutoscalingPolicyCpuUtilization()

Method Summary

Modifier and Type	Method and Description
AutoscalingPolicyCpuUtilization	clone()
String	getPredictiveMethod() Indicates whether predictive autoscaling based on CPU metric is enabled.
AutoscalingPolicySignalAggregation	getSignalAggregation() Defines how CPU utilization is aggregated in a group.
AutoscalingPolicyTimeAggregation	getTimeAggregation() Defines how CPU utilization is aggregated over time.
UtilizationRange	getUtilizationRange() Defines a target range for CPU utilization.
Double	getUtilizationTarget() The target CPU utilization that the autoscaler maintains.
AutoscalingPolicyCpuUtilization	set(String fieldName, Object value)
AutoscalingPolicyCpuUtilization	setPredictiveMethod(String predictiveMethod) Indicates whether predictive autoscaling based on CPU metric is enabled.
AutoscalingPolicyCpuUtilization	setSignalAggregation(AutoscalingPolicySignalAggregation signalAggregation) Defines how CPU utilization is aggregated in a group.
AutoscalingPolicyCpuUtilization	setTimeAggregation(AutoscalingPolicyTimeAggregation timeAggregation) Defines how CPU utilization is aggregated over time.
AutoscalingPolicyCpuUtilization	setUtilizationRange(UtilizationRange utilizationRange) Defines a target range for CPU utilization.
AutoscalingPolicyCpuUtilization	setUtilizationTarget(Double utilizationTarget) The target CPU utilization that the autoscaler maintains.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AutoscalingPolicyCpuUtilization

public AutoscalingPolicyCpuUtilization()

Method Detail

getPredictiveMethod

public String getPredictiveMethod()

Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: * NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.

Returns:

value or null for none

setPredictiveMethod

public AutoscalingPolicyCpuUtilization setPredictiveMethod(String predictiveMethod)

Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: * NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.

Parameters:

predictiveMethod - predictiveMethod or null for none

getSignalAggregation

public AutoscalingPolicySignalAggregation getSignalAggregation()

Defines how CPU utilization is aggregated in a group. Operates on the results from the `time_aggregation`, reducing the per-instance values down to a single aggregate value across the entire instance group if samples are available.

Returns:

value or null for none

setSignalAggregation

public AutoscalingPolicyCpuUtilization setSignalAggregation(AutoscalingPolicySignalAggregation signalAggregation)

Defines how CPU utilization is aggregated in a group. Operates on the results from the `time_aggregation`, reducing the per-instance values down to a single aggregate value across the entire instance group if samples are available.

Parameters:

signalAggregation - signalAggregation or null for none

getTimeAggregation

public AutoscalingPolicyTimeAggregation getTimeAggregation()

Defines how CPU utilization is aggregated over time. Operates on all CPU utilization samples produced by each instance over the `time_aggregation.time_window_sec`, reducing them to exactly one value per instance if samples are available.

Returns:

value or null for none

setTimeAggregation

public AutoscalingPolicyCpuUtilization setTimeAggregation(AutoscalingPolicyTimeAggregation timeAggregation)

Defines how CPU utilization is aggregated over time. Operates on all CPU utilization samples produced by each instance over the `time_aggregation.time_window_sec`, reducing them to exactly one value per instance if samples are available.

Parameters:

timeAggregation - timeAggregation or null for none

getUtilizationRange

public UtilizationRange getUtilizationRange()

Defines a target range for CPU utilization. The values of `min_utilization` and `max_utilization` must be in the range (0.0, 1.0]. If the average CPU is between `min_utilization` and `max_utilization`, the autoscaler maintains the current size unless another configured metric requires scaling out. If the average CPU is above `max_utilization`, the autoscaler scales out until the average utilization reaches the `utilization_range.utilization_target`. If the average CPU is below `min_utilization`, the autoscaler considers scaling in until the average utilization reaches the `utilization_range.utilization_target`. Scaling in can occur only if all other configured scaling metrics also suggest scaling in. At most one of CpuUtilization.utilization_target or CpuUtilization.utilization_range can be set.

Returns:

value or null for none

setUtilizationRange

public AutoscalingPolicyCpuUtilization setUtilizationRange(UtilizationRange utilizationRange)

Defines a target range for CPU utilization. The values of `min_utilization` and `max_utilization` must be in the range (0.0, 1.0]. If the average CPU is between `min_utilization` and `max_utilization`, the autoscaler maintains the current size unless another configured metric requires scaling out. If the average CPU is above `max_utilization`, the autoscaler scales out until the average utilization reaches the `utilization_range.utilization_target`. If the average CPU is below `min_utilization`, the autoscaler considers scaling in until the average utilization reaches the `utilization_range.utilization_target`. Scaling in can occur only if all other configured scaling metrics also suggest scaling in. At most one of CpuUtilization.utilization_target or CpuUtilization.utilization_range can be set.

Parameters:

utilizationRange - utilizationRange or null for none

getUtilizationTarget

public Double getUtilizationTarget()

The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Returns:

value or null for none

setUtilizationTarget

public AutoscalingPolicyCpuUtilization setUtilizationTarget(Double utilizationTarget)

The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

Parameters:

utilizationTarget - utilizationTarget or null for none

set

public AutoscalingPolicyCpuUtilization set(String fieldName,
                                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AutoscalingPolicyCpuUtilization clone()

Overrides:

clone in class com.google.api.client.json.GenericJson