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
andAggregation
.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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TimeSeriesTransformations.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.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.static TimeSeriesTransformations.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
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.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.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAggregation()
For responses, this returns true if the service returned a value for the Aggregation property.boolean
hasFilling()
For responses, this returns true if the service returned a value for the Filling property.int
hashCode()
Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends TimeSeriesTransformations.Builder>
serializableBuilderClass()
TimeSeriesTransformations.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 setbackfill
to a value of2
, 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 setbackfill
to a value of2
, 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 theisEmpty()
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 setbackfill
to a value of2
, 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 setbackfill
to a value of2
, 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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TimeSeriesTransformations.Builder,TimeSeriesTransformations>
-
builder
public static TimeSeriesTransformations.Builder builder()
-
serializableBuilderClass
public static Class<? extends TimeSeriesTransformations.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-