software.amazon.awssdk.services.forecast.model

Class Featurization

java.lang.Object

software.amazon.awssdk.services.forecast.model.Featurization

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class Featurization
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Featurization.Builder,Featurization>

Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

For example:

{

"AttributeName": "demand",

FeaturizationPipeline [ {

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}

} ]

}

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Featurization.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The name of the schema attribute that specifies the data field to be featurized.
static Featurization.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FeaturizationMethod>	featurizationPipeline() An array of one FeaturizationMethod object that specifies the feature transformation method.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeaturizationPipeline() Returns true if the FeaturizationPipeline property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Featurization.Builder>	serializableBuilderClass()
Featurization.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

attributeName

public String attributeName()

The name of the schema attribute that specifies the data field to be featurized. 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, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

Returns:

The name of the schema attribute that specifies the data field to be featurized. 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, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

hasFeaturizationPipeline

public boolean hasFeaturizationPipeline()

Returns true if the FeaturizationPipeline property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

featurizationPipeline

public List<FeaturizationMethod> featurizationPipeline()

An array of one FeaturizationMethod object that specifies the feature transformation method.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFeaturizationPipeline() to see if a value was sent in this field.

Returns:

An array of one FeaturizationMethod object that specifies the feature transformation method.

toBuilder

public Featurization.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Featurization.Builder,Featurization>

builder

public static Featurization.Builder builder()

serializableBuilderClass

public static Class<? extends Featurization.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo