ScalingPlan (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscalingplans.model.ScalingPlan

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingPlan
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents a scaling plan.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScalingPlan()

Constructors
Constructor and Description
`ScalingPlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScalingPlan`	`clone()`
`boolean`	`equals(Object obj)`
`ApplicationSource`	`getApplicationSource()` A CloudFormation stack or a set of tags.
`Date`	`getCreationTime()` The Unix time stamp when the scaling plan was created.
`List<ScalingInstruction>`	`getScalingInstructions()` The scaling instructions.
`String`	`getScalingPlanName()` The name of the scaling plan.
`Long`	`getScalingPlanVersion()` The version number of the scaling plan.
`String`	`getStatusCode()` The status of the scaling plan.
`String`	`getStatusMessage()` A simple message about the current status of the scaling plan.
`Date`	`getStatusStartTime()` The Unix time stamp when the scaling plan entered the current status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplicationSource(ApplicationSource applicationSource)` A CloudFormation stack or a set of tags.
`void`	`setCreationTime(Date creationTime)` The Unix time stamp when the scaling plan was created.
`void`	`setScalingInstructions(Collection<ScalingInstruction> scalingInstructions)` The scaling instructions.
`void`	`setScalingPlanName(String scalingPlanName)` The name of the scaling plan.
`void`	`setScalingPlanVersion(Long scalingPlanVersion)` The version number of the scaling plan.
`void`	`setStatusCode(String statusCode)` The status of the scaling plan.
`void`	`setStatusMessage(String statusMessage)` A simple message about the current status of the scaling plan.
`void`	`setStatusStartTime(Date statusStartTime)` The Unix time stamp when the scaling plan entered the current status.
`String`	`toString()` Returns a string representation of this object.
`ScalingPlan`	`withApplicationSource(ApplicationSource applicationSource)` A CloudFormation stack or a set of tags.
`ScalingPlan`	`withCreationTime(Date creationTime)` The Unix time stamp when the scaling plan was created.
`ScalingPlan`	`withScalingInstructions(Collection<ScalingInstruction> scalingInstructions)` The scaling instructions.
`ScalingPlan`	`withScalingInstructions(ScalingInstruction... scalingInstructions)` The scaling instructions.
`ScalingPlan`	`withScalingPlanName(String scalingPlanName)` The name of the scaling plan.
`ScalingPlan`	`withScalingPlanVersion(Long scalingPlanVersion)` The version number of the scaling plan.
`ScalingPlan`	`withStatusCode(ScalingPlanStatusCode statusCode)` The status of the scaling plan.
`ScalingPlan`	`withStatusCode(String statusCode)` The status of the scaling plan.
`ScalingPlan`	`withStatusMessage(String statusMessage)` A simple message about the current status of the scaling plan.
`ScalingPlan`	`withStatusStartTime(Date statusStartTime)` The Unix time stamp when the scaling plan entered the current status.

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

- Constructor Detail
  - ScalingPlan
```
public ScalingPlan()
```
- Method Detail
  - setScalingPlanName
```
public void setScalingPlanName(String scalingPlanName)
```
    The name of the scaling plan.
    
    Parameters:
    
    scalingPlanName - The name of the scaling plan.
  - getScalingPlanName
```
public String getScalingPlanName()
```
    The name of the scaling plan.
    
    Returns:
    
    The name of the scaling plan.
  - withScalingPlanName
```
public ScalingPlan withScalingPlanName(String scalingPlanName)
```
    The name of the scaling plan.
    
    Parameters:
    
    scalingPlanName - The name of the scaling plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScalingPlanVersion
```
public void setScalingPlanVersion(Long scalingPlanVersion)
```
    The version number of the scaling plan.
    
    Parameters:
    
    scalingPlanVersion - The version number of the scaling plan.
  - getScalingPlanVersion
```
public Long getScalingPlanVersion()
```
    The version number of the scaling plan.
    
    Returns:
    
    The version number of the scaling plan.
  - withScalingPlanVersion
```
public ScalingPlan withScalingPlanVersion(Long scalingPlanVersion)
```
    The version number of the scaling plan.
    
    Parameters:
    
    scalingPlanVersion - The version number of the scaling plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationSource
```
public void setApplicationSource(ApplicationSource applicationSource)
```
    A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
    
    Parameters:
    
    applicationSource - A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
  - getApplicationSource
```
public ApplicationSource getApplicationSource()
```
    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.
  - withApplicationSource
```
public ScalingPlan withApplicationSource(ApplicationSource applicationSource)
```
    A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
    
    Parameters:
    
    applicationSource - A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getScalingInstructions
```
public List<ScalingInstruction> getScalingInstructions()
```
    The scaling instructions.
    
    Returns:
    
    The scaling instructions.
  - setScalingInstructions
```
public void setScalingInstructions(Collection<ScalingInstruction> scalingInstructions)
```
    The scaling instructions.
    
    Parameters:
    
    scalingInstructions - The scaling instructions.
  - withScalingInstructions
```
public ScalingPlan withScalingInstructions(ScalingInstruction... scalingInstructions)
```
    The scaling instructions.
    
    NOTE: This method appends the values to the existing list (if any). Use setScalingInstructions(java.util.Collection) or withScalingInstructions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    scalingInstructions - The scaling instructions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withScalingInstructions
```
public ScalingPlan withScalingInstructions(Collection<ScalingInstruction> scalingInstructions)
```
    The scaling instructions.
    
    Parameters:
    
    scalingInstructions - The scaling instructions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusCode
```
public void setStatusCode(String 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.
    Parameters:
    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.
    See Also:
    
    ScalingPlanStatusCode
  - getStatusCode
```
public String getStatusCode()
```
    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.
    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
  - withStatusCode
```
public ScalingPlan withStatusCode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScalingPlanStatusCode
  - withStatusCode
```
public ScalingPlan withStatusCode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScalingPlanStatusCode
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A simple message about the current status of the scaling plan.
    
    Parameters:
    
    statusMessage - A simple message about the current status of the scaling plan.
  - getStatusMessage
```
public String getStatusMessage()
```
    A simple message about the current status of the scaling plan.
    
    Returns:
    
    A simple message about the current status of the scaling plan.
  - withStatusMessage
```
public ScalingPlan withStatusMessage(String statusMessage)
```
    A simple message about the current status of the scaling plan.
    
    Parameters:
    
    statusMessage - A simple message about the current status of the scaling plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusStartTime
```
public void setStatusStartTime(Date statusStartTime)
```
    The Unix time stamp when the scaling plan entered the current status.
    
    Parameters:
    
    statusStartTime - The Unix time stamp when the scaling plan entered the current status.
  - getStatusStartTime
```
public Date getStatusStartTime()
```
    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.
  - withStatusStartTime
```
public ScalingPlan withStatusStartTime(Date statusStartTime)
```
    The Unix time stamp when the scaling plan entered the current status.
    
    Parameters:
    
    statusStartTime - The Unix time stamp when the scaling plan entered the current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The Unix time stamp when the scaling plan was created.
    
    Parameters:
    
    creationTime - The Unix time stamp when the scaling plan was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The Unix time stamp when the scaling plan was created.
    
    Returns:
    
    The Unix time stamp when the scaling plan was created.
  - withCreationTime
```
public ScalingPlan withCreationTime(Date creationTime)
```
    The Unix time stamp when the scaling plan was created.
    
    Parameters:
    
    creationTime - The Unix time stamp when the scaling plan was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ScalingPlan clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ScalingPlan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScalingPlan

Method Detail

setScalingPlanName

getScalingPlanName

withScalingPlanName

setScalingPlanVersion

getScalingPlanVersion

withScalingPlanVersion

setApplicationSource

getApplicationSource

withApplicationSource

getScalingInstructions

setScalingInstructions

withScalingInstructions

withScalingInstructions

setStatusCode

getStatusCode

withStatusCode

withStatusCode

setStatusMessage

getStatusMessage

withStatusMessage

setStatusStartTime

getStatusStartTime

withStatusStartTime

setCreationTime

getCreationTime

withCreationTime

toString

equals

hashCode

clone

marshall