Class FeaturizationMethod

java.lang.Object
software.amazon.awssdk.services.forecast.model.FeaturizationMethod
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FeaturizationMethod.Builder,FeaturizationMethod>
@Generated("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:

  • Method Details

    • featurizationMethodName

      public final 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:

    • featurizationMethodNameAsString

      public final 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:

    • hasFeaturizationMethodParameters

      public final boolean hasFeaturizationMethodParameters()
      For responses, this returns true if the service returned a value for the FeaturizationMethodParameters 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.

    • featurizationMethodParameters

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

      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 hasFeaturizationMethodParameters() 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. 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FeaturizationMethod.Builder,FeaturizationMethod>
      Returns:
      a builder for type T

    • builder

      public static FeaturizationMethod.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FeaturizationMethod.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.