Class ScalingPlan

java.lang.Object
software.amazon.awssdk.services.autoscalingplans.model.ScalingPlan
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>
@Generated("software.amazon.awssdk:codegen") public final class ScalingPlan extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPlan.Builder,ScalingPlan>

Represents a scaling plan.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.