com.amazonaws.services.forecast.model

Class FeaturizationMethod

java.lang.Object

com.amazonaws.services.forecast.model.FeaturizationMethod

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FeaturizationMethod
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FeaturizationMethod()

Method Summary

Modifier and Type	Method and Description
FeaturizationMethod	addFeaturizationMethodParametersEntry(String key, String value) Add a single FeaturizationMethodParameters entry
FeaturizationMethod	clearFeaturizationMethodParametersEntries() Removes all the entries added into FeaturizationMethodParameters.
FeaturizationMethod	clone()
boolean	equals(Object obj)
String	getFeaturizationMethodName() The name of the method.
Map<String,String>	getFeaturizationMethodParameters() The method parameters (key-value pairs), which are a map of override parameters.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setFeaturizationMethodName(String featurizationMethodName) The name of the method.
void	setFeaturizationMethodParameters(Map<String,String> featurizationMethodParameters) The method parameters (key-value pairs), which are a map of override parameters.
String	toString() Returns a string representation of this object.
FeaturizationMethod	withFeaturizationMethodName(FeaturizationMethodName featurizationMethodName) The name of the method.
FeaturizationMethod	withFeaturizationMethodName(String featurizationMethodName) The name of the method.
FeaturizationMethod	withFeaturizationMethodParameters(Map<String,String> featurizationMethodParameters) The method parameters (key-value pairs), which are a map of override parameters.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FeaturizationMethod

public FeaturizationMethod()

Method Detail

setFeaturizationMethodName

public void setFeaturizationMethodName(String featurizationMethodName)

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

Parameters:

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

See Also:

FeaturizationMethodName

getFeaturizationMethodName

public String getFeaturizationMethodName()

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

Returns:

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

See Also:

FeaturizationMethodName

withFeaturizationMethodName

public FeaturizationMethod withFeaturizationMethodName(String featurizationMethodName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FeaturizationMethodName

withFeaturizationMethodName

public FeaturizationMethod withFeaturizationMethodName(FeaturizationMethodName featurizationMethodName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FeaturizationMethodName

getFeaturizationMethodParameters

public Map<String,String> getFeaturizationMethodParameters()

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

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

setFeaturizationMethodParameters

public void setFeaturizationMethodParameters(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".

Parameters:

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

withFeaturizationMethodParameters

public FeaturizationMethod withFeaturizationMethodParameters(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".

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addFeaturizationMethodParametersEntry

public FeaturizationMethod addFeaturizationMethodParametersEntry(String key,
                                                                 String value)

Add a single FeaturizationMethodParameters entry

See Also:

withFeaturizationMethodParameters(java.util.Map<java.lang.String, java.lang.String>)

clearFeaturizationMethodParametersEntries

public FeaturizationMethod clearFeaturizationMethodParametersEntries()

Removes all the entries added into FeaturizationMethodParameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FeaturizationMethod clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo