Package software.amazon.awssdk.services.forecast.model

Class Action

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

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName": "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

See Also:

  • Method Details

    • attributeName

      public final String attributeName()

      The related time series that you are modifying. This value is case insensitive.

      Returns:
      The related time series that you are modifying. This value is case insensitive.

    • operation

      public final Operation operation()

      The operation that is applied to the provided attribute. Operations include:

      • ADD - adds Value to all rows of AttributeName.

      • SUBTRACT - subtracts Value from all rows of AttributeName.

      • MULTIPLY - multiplies all rows of AttributeName by Value.

      • DIVIDE - divides all rows of AttributeName by Value.

      If the service returns an enum value that is not available in the current SDK version, operation will return Operation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      The operation that is applied to the provided attribute. Operations include:

      • ADD - adds Value to all rows of AttributeName.

      • SUBTRACT - subtracts Value from all rows of AttributeName.

      • MULTIPLY - multiplies all rows of AttributeName by Value.

      • DIVIDE - divides all rows of AttributeName by Value.

      See Also:

    • operationAsString

      public final String operationAsString()

      The operation that is applied to the provided attribute. Operations include:

      • ADD - adds Value to all rows of AttributeName.

      • SUBTRACT - subtracts Value from all rows of AttributeName.

      • MULTIPLY - multiplies all rows of AttributeName by Value.

      • DIVIDE - divides all rows of AttributeName by Value.

      If the service returns an enum value that is not available in the current SDK version, operation will return Operation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      The operation that is applied to the provided attribute. Operations include:

      • ADD - adds Value to all rows of AttributeName.

      • SUBTRACT - subtracts Value from all rows of AttributeName.

      • MULTIPLY - multiplies all rows of AttributeName by Value.

      • DIVIDE - divides all rows of AttributeName by Value.

      See Also:

    • value

      public final Double value()

      The value that is applied for the chosen Operation.

      Returns:
      The value that is applied for the chosen Operation.

    • toBuilder

      public Action.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<Action.Builder,Action>
      Returns:
      a builder for type T

    • builder

      public static Action.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Action.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.