ScalingPlan (AWS Java SDK :: Services :: Auto Scaling Plans 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.autoscalingplans.model.ScalingPlan

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingPlan
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>

Represents a scaling plan.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScalingPlan.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ScalingPlan.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplicationSource`	`applicationSource()` A CloudFormation stack or a set of tags.
`static ScalingPlan.Builder`	`builder()`
`Instant`	`creationTime()` The Unix time stamp when the scaling plan was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasScalingInstructions()` For responses, this returns true if the service returned a value for the ScalingInstructions property.
`List<ScalingInstruction>`	`scalingInstructions()` The scaling instructions.
`String`	`scalingPlanName()` The name of the scaling plan.
`Long`	`scalingPlanVersion()` The version number of the scaling plan.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScalingPlan.Builder>`	`serializableBuilderClass()`
`ScalingPlanStatusCode`	`statusCode()` The status of the scaling plan.
`String`	`statusCodeAsString()` The status of the scaling plan.
`String`	`statusMessage()` A simple message about the current status of the scaling plan.
`Instant`	`statusStartTime()` The Unix time stamp when the scaling plan entered the current status.
`ScalingPlan.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
  - scalingPlanName
```
public final String scalingPlanName()
```
    The name of the scaling plan.
    
    Returns:
    
    The name of the scaling plan.
  - scalingPlanVersion
```
public final Long scalingPlanVersion()
```
    The version number of the scaling plan.
    
    Returns:
    
    The version number of the scaling plan.
  - applicationSource
```
public final ApplicationSource applicationSource()
```
    A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
    
    Returns:
    
    A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
  - hasScalingInstructions
```
public final boolean hasScalingInstructions()
```
    For responses, this returns true if the service returned a value for the ScalingInstructions 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.
  - scalingInstructions
```
public final List<ScalingInstruction> scalingInstructions()
```
    The scaling instructions.
    
    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 hasScalingInstructions() method.
    
    Returns:
    
    The scaling instructions.
  - statusCode
```
public final ScalingPlanStatusCode statusCode()
```
    The status of the scaling plan.
    - Active - The scaling plan is active.
    - ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.
    - CreationInProgress - The scaling plan is being created.
    - CreationFailed - The scaling plan could not be created.
    - DeletionInProgress - The scaling plan is being deleted.
    - DeletionFailed - The scaling plan could not be deleted.
    - UpdateInProgress - The scaling plan is being updated.
    - UpdateFailed - The scaling plan could not be updated.
    If the service returns an enum value that is not available in the current SDK version, statusCode will return ScalingPlanStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    Returns:
    The status of the scaling plan.
    
    Active - The scaling plan is active.
    
    ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.
    
    CreationInProgress - The scaling plan is being created.
    
    CreationFailed - The scaling plan could not be created.
    
    DeletionInProgress - The scaling plan is being deleted.
    
    DeletionFailed - The scaling plan could not be deleted.
    
    UpdateInProgress - The scaling plan is being updated.
    
    UpdateFailed - The scaling plan could not be updated.
    See Also:
    
    ScalingPlanStatusCode
  - statusCodeAsString
```
public final String statusCodeAsString()
```
    The status of the scaling plan.
    - Active - The scaling plan is active.
    - ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.
    - CreationInProgress - The scaling plan is being created.
    - CreationFailed - The scaling plan could not be created.
    - DeletionInProgress - The scaling plan is being deleted.
    - DeletionFailed - The scaling plan could not be deleted.
    - UpdateInProgress - The scaling plan is being updated.
    - UpdateFailed - The scaling plan could not be updated.
    If the service returns an enum value that is not available in the current SDK version, statusCode will return ScalingPlanStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    Returns:
    The status of the scaling plan.
    
    Active - The scaling plan is active.
    
    ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.
    
    CreationInProgress - The scaling plan is being created.
    
    CreationFailed - The scaling plan could not be created.
    
    DeletionInProgress - The scaling plan is being deleted.
    
    DeletionFailed - The scaling plan could not be deleted.
    
    UpdateInProgress - The scaling plan is being updated.
    
    UpdateFailed - The scaling plan could not be updated.
    See Also:
    
    ScalingPlanStatusCode
  - statusMessage
```
public final String statusMessage()
```
    A simple message about the current status of the scaling plan.
    
    Returns:
    
    A simple message about the current status of the scaling plan.
  - statusStartTime
```
public final Instant statusStartTime()
```
    The Unix time stamp when the scaling plan entered the current status.
    
    Returns:
    
    The Unix time stamp when the scaling plan entered the current status.
  - creationTime
```
public final Instant creationTime()
```
    The Unix time stamp when the scaling plan was created.
    
    Returns:
    
    The Unix time stamp when the scaling plan was created.
  - toBuilder
```
public ScalingPlan.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>
  - builder
```
public static ScalingPlan.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalingPlan.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

Class ScalingPlan

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

scalingPlanName

scalingPlanVersion

applicationSource

hasScalingInstructions

scalingInstructions

statusCode

statusCodeAsString

statusMessage

statusStartTime

creationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields