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. If you don't specify FeaturizationMethodParameters, Amazon Forecast uses default parameters.

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

{

"FeaturizationMethodName": "filling",

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

}

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)
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).
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFeaturizationMethodName(String featurizationMethodName) The name of the method.
void	setFeaturizationMethodParameters(Map<String,String> featurizationMethodParameters) The method parameters (key-value pairs).
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).

Methods inherited from class java.lang.Object

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). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

Returns:

The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

setFeaturizationMethodParameters

public void setFeaturizationMethodParameters(Map<String,String> featurizationMethodParameters)

The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

Parameters:

featurizationMethodParameters - The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

withFeaturizationMethodParameters

public FeaturizationMethod withFeaturizationMethodParameters(Map<String,String> featurizationMethodParameters)

The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

Parameters:

featurizationMethodParameters - The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

• aggregation: sum, avg, first, min, max

• frontfill: none

• middlefill: zero, nan (not a number)

• backfill: zero, nan

Returns:

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

addFeaturizationMethodParametersEntry

public FeaturizationMethod addFeaturizationMethodParametersEntry(String key,
                                                                 String value)

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)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.