Class TimeSeriesTransformations

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

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

See Also:

  • Method Details

    • filling

      public final Map<String,Map<FillingType,String>> filling()

      A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

      The supported filling methods and their corresponding options are:

      • frontfill: none (Supported only for target column)

      • middlefill: zero, value, median, mean, min, max

      • backfill: zero, value, median, mean, min, max

      • futurefill: zero, value, median, mean, min, max

      To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

      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 hasFilling() method.

      Returns:
      A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

      The supported filling methods and their corresponding options are:

      • frontfill: none (Supported only for target column)

      • middlefill: zero, value, median, mean, min, max

      • backfill: zero, value, median, mean, min, max

      • futurefill: zero, value, median, mean, min, max

      To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

    • hasFilling

      public final boolean hasFilling()
      For responses, this returns true if the service returned a value for the Filling 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.

    • fillingAsStrings

      public final Map<String,Map<String,String>> fillingAsStrings()

      A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

      The supported filling methods and their corresponding options are:

      • frontfill: none (Supported only for target column)

      • middlefill: zero, value, median, mean, min, max

      • backfill: zero, value, median, mean, min, max

      • futurefill: zero, value, median, mean, min, max

      To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

      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 hasFilling() method.

      Returns:
      A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

      The supported filling methods and their corresponding options are:

      • frontfill: none (Supported only for target column)

      • middlefill: zero, value, median, mean, min, max

      • backfill: zero, value, median, mean, min, max

      • futurefill: zero, value, median, mean, min, max

      To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

    • aggregation

      public final Map<String,AggregationTransformationValue> aggregation()

      A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

      The supported aggregation methods are sum (default), avg, first, min, max.

      Aggregation is only supported for the target column.

      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 hasAggregation() method.

      Returns:
      A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

      The supported aggregation methods are sum (default), avg, first, min, max.

      Aggregation is only supported for the target column.

    • hasAggregation

      public final boolean hasAggregation()
      For responses, this returns true if the service returned a value for the Aggregation 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.

    • aggregationAsStrings

      public final Map<String,String> aggregationAsStrings()

      A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

      The supported aggregation methods are sum (default), avg, first, min, max.

      Aggregation is only supported for the target column.

      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 hasAggregation() method.

      Returns:
      A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

      The supported aggregation methods are sum (default), avg, first, min, max.

      Aggregation is only supported for the target column.

    • toBuilder

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

    • builder

      public static TimeSeriesTransformations.Builder builder()

    • serializableBuilderClass

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