software.amazon.awssdk.services.forecast.model

Class FeaturizationMethod

java.lang.Object

software.amazon.awssdk.services.forecast.model.FeaturizationMethod

All Implemented Interfaces:

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

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

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object.

The following is an example of how you specify a FeaturizationMethod object.

{

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

}

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FeaturizationMethod.Builder

Method Summary

Modifier and Type	Method and Description
static FeaturizationMethod.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FeaturizationMethodName	featurizationMethodName() The name of the method.
String	featurizationMethodNameAsString() The name of the method.
Map<String,String>	featurizationMethodParameters() The method parameters (key-value pairs), which are a map of override parameters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeaturizationMethodParameters() Returns true if the FeaturizationMethodParameters 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 FeaturizationMethod.Builder>	serializableBuilderClass()
FeaturizationMethod.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

featurizationMethodName

public FeaturizationMethodName featurizationMethodName()

The name of the method. The "filling" method is the only supported method.

If the service returns an enum value that is not available in the current SDK version, featurizationMethodName will return FeaturizationMethodName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featurizationMethodNameAsString().

Returns:

The name of the method. The "filling" method is the only supported method.

See Also:

FeaturizationMethodName

featurizationMethodNameAsString

public String featurizationMethodNameAsString()

The name of the method. The "filling" method is the only supported method.

If the service returns an enum value that is not available in the current SDK version, featurizationMethodName will return FeaturizationMethodName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featurizationMethodNameAsString().

Returns:

The name of the method. The "filling" method is the only supported method.

See Also:

FeaturizationMethodName

hasFeaturizationMethodParameters

public boolean hasFeaturizationMethodParameters()

Returns true if the FeaturizationMethodParameters 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.

featurizationMethodParameters

public Map<String,String> featurizationMethodParameters()

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. Bold signifies the default value.

• 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.

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

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. Bold signifies the default value.

• 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 FeaturizationMethod.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FeaturizationMethod.Builder,FeaturizationMethod>

builder

public static FeaturizationMethod.Builder builder()

serializableBuilderClass

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