Class AttributeConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttributeConfig.Builder,
AttributeConfig>
Provides information about the method used to transform attributes.
The following is an example using the RETAIL domain:
{
"AttributeName": "demand",
"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}
}
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the attribute as specified in the schema.static AttributeConfig.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Transformations property.static Class
<? extends AttributeConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The method parameters (key-value pairs), which are a map of override parameters.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attributeName
The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the target time series and the related time series datasets. For example, for the RETAIL domain, the target is
demand
.- Returns:
- The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the
target time series and the related time series datasets. For example, for the RETAIL domain, the target
is
demand
.
-
hasTransformations
public final boolean hasTransformations()For responses, this returns true if the service returned a value for the Transformations 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. -
transformations
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Default values are bolded.
-
aggregation
: sum,avg
,first
,min
,max
-
frontfill
: none -
middlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
-
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
-
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
value
and define the value in a corresponding_value
parameter. For example, to set backfilling to a value of 2, include the following:"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
hasTransformations()
method.- Returns:
- The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters
to override the default values. Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Default values are bolded.
-
aggregation
: sum,avg
,first
,min
,max
-
frontfill
: none -
middlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
-
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
-
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
value
and define the value in a corresponding_value
parameter. For example, to set backfilling to a value of 2, include the following:"backfill": "value"
and"backfill_value":"2"
. -
-
-
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 interfaceToCopyableBuilder<AttributeConfig.Builder,
AttributeConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-