java.lang.Object
- software.amazon.awssdk.services.applicationautoscaling.model.PredictiveScalingPolicyConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class PredictiveScalingPolicyConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>
```
Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PredictiveScalingPolicyConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PredictiveScalingPolicyConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetricSpecifications()`	For responses, this returns true if the service returned a value for the MetricSpecifications property.
`PredictiveScalingMaxCapacityBreachBehavior`	`maxCapacityBreachBehavior()`	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity.
`String`	`maxCapacityBreachBehaviorAsString()`	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity.
`Integer`	`maxCapacityBuffer()`	The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
`List<PredictiveScalingMetricSpecification>`	`metricSpecifications()`	This structure includes the metrics and target utilization to use for predictive scaling.
`PredictiveScalingMode`	`mode()`	The predictive scaling mode.
`String`	`modeAsString()`	The predictive scaling mode.
`Integer`	`schedulingBufferTime()`	The amount of time, in seconds, that the start time can be advanced.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PredictiveScalingPolicyConfiguration.Builder>`	`serializableBuilderClass()`
`PredictiveScalingPolicyConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasMetricSpecifications
```
public final boolean hasMetricSpecifications()
```
    For responses, this returns true if the service returned a value for the MetricSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - metricSpecifications
```
public final List<PredictiveScalingMetricSpecification> metricSpecifications()
```
    This structure includes the metrics and target utilization to use for predictive scaling.
    
    This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricSpecifications() method.
    
    Returns:
    
    This structure includes the metrics and target utilization to use for predictive scaling.
    
    This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
  - mode
```
public final PredictiveScalingMode mode()
```
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    
    See Also:
    
    PredictiveScalingMode
  - modeAsString
```
public final String modeAsString()
```
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    
    See Also:
    
    PredictiveScalingMode
  - schedulingBufferTime
```
public final Integer schedulingBufferTime()
```
    The amount of time, in seconds, that the start time can be advanced.
    
    The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
    
    Returns:
    
    The amount of time, in seconds, that the start time can be advanced.
    
    The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
  - maxCapacityBreachBehavior
```
public final PredictiveScalingMaxCapacityBreachBehavior maxCapacityBreachBehavior()
```
    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
    
    If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().
    
    Returns:
    
    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
    
    See Also:
    
    PredictiveScalingMaxCapacityBreachBehavior
  - maxCapacityBreachBehaviorAsString
```
public final String maxCapacityBreachBehaviorAsString()
```
    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
    
    If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().
    
    Returns:
    
    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
    
    See Also:
    
    PredictiveScalingMaxCapacityBreachBehavior
  - maxCapacityBuffer
```
public final Integer maxCapacityBuffer()
```
    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
    
    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
    
    Returns:
    
    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
    
    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
  - toBuilder
```
public PredictiveScalingPolicyConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>
  - builder
```
public static PredictiveScalingPolicyConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PredictiveScalingPolicyConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PredictiveScalingPolicyConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasMetricSpecifications

metricSpecifications

mode

modeAsString

schedulingBufferTime

maxCapacityBreachBehavior

maxCapacityBreachBehaviorAsString

maxCapacityBuffer

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField