software.amazon.awssdk.services.forecast.model

Class AttributeConfig

java.lang.Object

software.amazon.awssdk.services.forecast.model.AttributeConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AttributeConfig.Builder,AttributeConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class AttributeConfig
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttributeConfig.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of the attribute as specified in the schema.
static AttributeConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTransformations() For responses, this returns true if the service returned a value for the Transformations property.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributeConfig.Builder>	serializableBuilderClass()
AttributeConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,String>	transformations() The method parameters (key-value pairs), which are a map of override parameters.

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

attributeName

public final String 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 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.

transformations

public final Map<String,String> 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

public AttributeConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeConfig.Builder,AttributeConfig>

builder

public static AttributeConfig.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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