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

The ExplainabilityConfig data type defines the number of time series and time * points included in CreateExplainability.

If you provide a * predictor ARN for ResourceArn, you must set both * TimePointGranularity and TimeSeriesGranularity to * “ALL”. When creating Predictor Explainability, Amazon Forecast considers all * time series and time points.

If you provide a forecast ARN for * ResourceArn, you can set TimePointGranularity and * TimeSeriesGranularity to either “ALL” or “Specific”.

See * Also:

AWS * API Reference

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

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline const TimeSeriesGranularity& GetTimeSeriesGranularity() const{ return m_timeSeriesGranularity; } /** *

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline bool TimeSeriesGranularityHasBeenSet() const { return m_timeSeriesGranularityHasBeenSet; } /** *

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline void SetTimeSeriesGranularity(const TimeSeriesGranularity& value) { m_timeSeriesGranularityHasBeenSet = true; m_timeSeriesGranularity = value; } /** *

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline void SetTimeSeriesGranularity(TimeSeriesGranularity&& value) { m_timeSeriesGranularityHasBeenSet = true; m_timeSeriesGranularity = std::move(value); } /** *

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline ExplainabilityConfig& WithTimeSeriesGranularity(const TimeSeriesGranularity& value) { SetTimeSeriesGranularity(value); return *this;} /** *

To create an Explainability for all time series in your datasets, use * ALL. To create an Explainability for specific time series in your * datasets, use SPECIFIC.

Specify time series by uploading a * CSV or Parquet file to an Amazon S3 bucket and set the location within the * DataDestination data type.

*/ inline ExplainabilityConfig& WithTimeSeriesGranularity(TimeSeriesGranularity&& value) { SetTimeSeriesGranularity(std::move(value)); return *this;} /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline const TimePointGranularity& GetTimePointGranularity() const{ return m_timePointGranularity; } /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline bool TimePointGranularityHasBeenSet() const { return m_timePointGranularityHasBeenSet; } /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline void SetTimePointGranularity(const TimePointGranularity& value) { m_timePointGranularityHasBeenSet = true; m_timePointGranularity = value; } /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline void SetTimePointGranularity(TimePointGranularity&& value) { m_timePointGranularityHasBeenSet = true; m_timePointGranularity = std::move(value); } /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline ExplainabilityConfig& WithTimePointGranularity(const TimePointGranularity& value) { SetTimePointGranularity(value); return *this;} /** *

To create an Explainability for all time points in your forecast horizon, use * ALL. To create an Explainability for specific time points in your * forecast horizon, use SPECIFIC.

Specify time points with the * StartDateTime and EndDateTime parameters within the * CreateExplainability operation.

*/ inline ExplainabilityConfig& WithTimePointGranularity(TimePointGranularity&& value) { SetTimePointGranularity(std::move(value)); return *this;} private: TimeSeriesGranularity m_timeSeriesGranularity; bool m_timeSeriesGranularityHasBeenSet = false; TimePointGranularity m_timePointGranularity; bool m_timePointGranularityHasBeenSet = false; }; } // namespace Model } // namespace ForecastService } // namespace Aws