Package 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("software.amazon.awssdk:codegen") public final class Featurization extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Featurization.Builder,Featurization>

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

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:

  • Method Details

    • attributeName

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

    • featurizationPipeline

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

      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 hasFeaturizationPipeline() method.

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

    • toBuilder

      public Featurization.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<Featurization.Builder,Featurization>
      Returns:
      a builder for type T

    • builder

      public static Featurization.Builder builder()

    • serializableBuilderClass

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