/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ForecastService { namespace Model { /** *

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 Reference

*/ class FeaturizationMethod { public: AWS_FORECASTSERVICE_API FeaturizationMethod(); AWS_FORECASTSERVICE_API FeaturizationMethod(Aws::Utils::Json::JsonView jsonValue); AWS_FORECASTSERVICE_API FeaturizationMethod& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_FORECASTSERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const FeaturizationMethodName& GetFeaturizationMethodName() const{ return m_featurizationMethodName; } /** *

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

*/ inline bool FeaturizationMethodNameHasBeenSet() const { return m_featurizationMethodNameHasBeenSet; } /** *

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

*/ inline void SetFeaturizationMethodName(const FeaturizationMethodName& value) { m_featurizationMethodNameHasBeenSet = true; m_featurizationMethodName = value; } /** *

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

*/ inline void SetFeaturizationMethodName(FeaturizationMethodName&& value) { m_featurizationMethodNameHasBeenSet = true; m_featurizationMethodName = std::move(value); } /** *

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

*/ inline FeaturizationMethod& WithFeaturizationMethodName(const FeaturizationMethodName& value) { SetFeaturizationMethodName(value); return *this;} /** *

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

*/ inline FeaturizationMethod& WithFeaturizationMethodName(FeaturizationMethodName&& value) { SetFeaturizationMethodName(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Map& GetFeaturizationMethodParameters() const{ return m_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".

*/ inline bool FeaturizationMethodParametersHasBeenSet() const { return m_featurizationMethodParametersHasBeenSet; } /** *

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

*/ inline void SetFeaturizationMethodParameters(const Aws::Map& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters = value; } /** *

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

*/ inline void SetFeaturizationMethodParameters(Aws::Map&& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters = std::move(value); } /** *

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

*/ inline FeaturizationMethod& WithFeaturizationMethodParameters(const Aws::Map& value) { SetFeaturizationMethodParameters(value); return *this;} /** *

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

*/ inline FeaturizationMethod& WithFeaturizationMethodParameters(Aws::Map&& value) { SetFeaturizationMethodParameters(std::move(value)); return *this;} /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(const Aws::String& key, const Aws::String& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(key, value); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(Aws::String&& key, const Aws::String& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(std::move(key), value); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(const Aws::String& key, Aws::String&& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(key, std::move(value)); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(Aws::String&& key, Aws::String&& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(std::move(key), std::move(value)); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(const char* key, Aws::String&& value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(key, std::move(value)); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(Aws::String&& key, const char* value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(std::move(key), value); return *this; } /** *

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

*/ inline FeaturizationMethod& AddFeaturizationMethodParameters(const char* key, const char* value) { m_featurizationMethodParametersHasBeenSet = true; m_featurizationMethodParameters.emplace(key, value); return *this; } private: FeaturizationMethodName m_featurizationMethodName; bool m_featurizationMethodNameHasBeenSet = false; Aws::Map m_featurizationMethodParameters; bool m_featurizationMethodParametersHasBeenSet = false; }; } // namespace Model } // namespace ForecastService } // namespace Aws