Class TimeSeriesCondition

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

Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost $5 or less. To do this, you specify "AttributeName": "price", "AttributeValue": "5", and "Condition": "LESS_THAN". Pair this operation with the Action operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define how the attribute is modified.

See Also:

  • Method Details

    • attributeName

      public final String attributeName()

      The item_id, dimension name, IM name, or timestamp that you are modifying.

      Returns:
      The item_id, dimension name, IM name, or timestamp that you are modifying.

    • attributeValue

      public final String attributeValue()

      The value that is applied for the chosen Condition.

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

    • condition

      public final Condition condition()

      The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.

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

      Returns:
      The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.
      See Also:

    • conditionAsString

      public final String conditionAsString()

      The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.

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

      Returns:
      The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.
      See Also:

    • toBuilder

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

    • builder

      public static TimeSeriesCondition.Builder builder()

    • serializableBuilderClass

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