ScalingPlan (AWS SDK for Java

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()` The application source.
`static ScalingPlan.Builder`	`builder()`
`Instant`	`creationTime()` The Unix time stamp when the scaling plan was created.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - scalingPlanName
```
public String scalingPlanName()
```
    The name of the scaling plan.
    
    Returns:
    
    The name of the scaling plan.
  - scalingPlanVersion
```
public Long scalingPlanVersion()
```
    The version number of the scaling plan.
    
    Returns:
    
    The version number of the scaling plan.
  - applicationSource
```
public ApplicationSource applicationSource()
```
    The application source.
    
    Returns:
    
    The application source.
  - scalingInstructions
```
public List<ScalingInstruction> scalingInstructions()
```
    The scaling instructions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The scaling instructions.
  - statusCode
```
public 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 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 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 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 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ScalingPlan.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalingPlan.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

scalingInstructions

statusCode

statusCodeAsString

statusMessage

statusStartTime

creationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields