/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace ForecastService { namespace Model { class DescribeForecastResult { public: AWS_FORECASTSERVICE_API DescribeForecastResult(); AWS_FORECASTSERVICE_API DescribeForecastResult(const Aws::AmazonWebServiceResult& result); AWS_FORECASTSERVICE_API DescribeForecastResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The forecast ARN as specified in the request.

*/ inline const Aws::String& GetForecastArn() const{ return m_forecastArn; } /** *

The forecast ARN as specified in the request.

*/ inline void SetForecastArn(const Aws::String& value) { m_forecastArn = value; } /** *

The forecast ARN as specified in the request.

*/ inline void SetForecastArn(Aws::String&& value) { m_forecastArn = std::move(value); } /** *

The forecast ARN as specified in the request.

*/ inline void SetForecastArn(const char* value) { m_forecastArn.assign(value); } /** *

The forecast ARN as specified in the request.

*/ inline DescribeForecastResult& WithForecastArn(const Aws::String& value) { SetForecastArn(value); return *this;} /** *

The forecast ARN as specified in the request.

*/ inline DescribeForecastResult& WithForecastArn(Aws::String&& value) { SetForecastArn(std::move(value)); return *this;} /** *

The forecast ARN as specified in the request.

*/ inline DescribeForecastResult& WithForecastArn(const char* value) { SetForecastArn(value); return *this;} /** *

The name of the forecast.

*/ inline const Aws::String& GetForecastName() const{ return m_forecastName; } /** *

The name of the forecast.

*/ inline void SetForecastName(const Aws::String& value) { m_forecastName = value; } /** *

The name of the forecast.

*/ inline void SetForecastName(Aws::String&& value) { m_forecastName = std::move(value); } /** *

The name of the forecast.

*/ inline void SetForecastName(const char* value) { m_forecastName.assign(value); } /** *

The name of the forecast.

*/ inline DescribeForecastResult& WithForecastName(const Aws::String& value) { SetForecastName(value); return *this;} /** *

The name of the forecast.

*/ inline DescribeForecastResult& WithForecastName(Aws::String&& value) { SetForecastName(std::move(value)); return *this;} /** *

The name of the forecast.

*/ inline DescribeForecastResult& WithForecastName(const char* value) { SetForecastName(value); return *this;} /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline const Aws::Vector& GetForecastTypes() const{ return m_forecastTypes; } /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline void SetForecastTypes(const Aws::Vector& value) { m_forecastTypes = value; } /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline void SetForecastTypes(Aws::Vector&& value) { m_forecastTypes = std::move(value); } /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline DescribeForecastResult& WithForecastTypes(const Aws::Vector& value) { SetForecastTypes(value); return *this;} /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline DescribeForecastResult& WithForecastTypes(Aws::Vector&& value) { SetForecastTypes(std::move(value)); return *this;} /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline DescribeForecastResult& AddForecastTypes(const Aws::String& value) { m_forecastTypes.push_back(value); return *this; } /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline DescribeForecastResult& AddForecastTypes(Aws::String&& value) { m_forecastTypes.push_back(std::move(value)); return *this; } /** *

The quantiles at which probabilistic forecasts were generated.

*/ inline DescribeForecastResult& AddForecastTypes(const char* value) { m_forecastTypes.push_back(value); return *this; } /** *

The ARN of the predictor used to generate the forecast.

*/ inline const Aws::String& GetPredictorArn() const{ return m_predictorArn; } /** *

The ARN of the predictor used to generate the forecast.

*/ inline void SetPredictorArn(const Aws::String& value) { m_predictorArn = value; } /** *

The ARN of the predictor used to generate the forecast.

*/ inline void SetPredictorArn(Aws::String&& value) { m_predictorArn = std::move(value); } /** *

The ARN of the predictor used to generate the forecast.

*/ inline void SetPredictorArn(const char* value) { m_predictorArn.assign(value); } /** *

The ARN of the predictor used to generate the forecast.

*/ inline DescribeForecastResult& WithPredictorArn(const Aws::String& value) { SetPredictorArn(value); return *this;} /** *

The ARN of the predictor used to generate the forecast.

*/ inline DescribeForecastResult& WithPredictorArn(Aws::String&& value) { SetPredictorArn(std::move(value)); return *this;} /** *

The ARN of the predictor used to generate the forecast.

*/ inline DescribeForecastResult& WithPredictorArn(const char* value) { SetPredictorArn(value); return *this;} /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline const Aws::String& GetDatasetGroupArn() const{ return m_datasetGroupArn; } /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline void SetDatasetGroupArn(const Aws::String& value) { m_datasetGroupArn = value; } /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline void SetDatasetGroupArn(Aws::String&& value) { m_datasetGroupArn = std::move(value); } /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline void SetDatasetGroupArn(const char* value) { m_datasetGroupArn.assign(value); } /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline DescribeForecastResult& WithDatasetGroupArn(const Aws::String& value) { SetDatasetGroupArn(value); return *this;} /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline DescribeForecastResult& WithDatasetGroupArn(Aws::String&& value) { SetDatasetGroupArn(std::move(value)); return *this;} /** *

The ARN of the dataset group that provided the data used to train the * predictor.

*/ inline DescribeForecastResult& WithDatasetGroupArn(const char* value) { SetDatasetGroupArn(value); return *this;} /** *

The estimated time remaining in minutes for the forecast job to complete.

*/ inline long long GetEstimatedTimeRemainingInMinutes() const{ return m_estimatedTimeRemainingInMinutes; } /** *

The estimated time remaining in minutes for the forecast job to complete.

*/ inline void SetEstimatedTimeRemainingInMinutes(long long value) { m_estimatedTimeRemainingInMinutes = value; } /** *

The estimated time remaining in minutes for the forecast job to complete.

*/ inline DescribeForecastResult& WithEstimatedTimeRemainingInMinutes(long long value) { SetEstimatedTimeRemainingInMinutes(value); return *this;} /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline void SetStatus(const Aws::String& value) { m_status = value; } /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline void SetStatus(Aws::String&& value) { m_status = std::move(value); } /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline void SetStatus(const char* value) { m_status.assign(value); } /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline DescribeForecastResult& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline DescribeForecastResult& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the forecast. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

The Status of * the forecast must be ACTIVE before you can query or export the * forecast.

*/ inline DescribeForecastResult& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

If an error occurred, an informational message about the error.

*/ inline const Aws::String& GetMessage() const{ return m_message; } /** *

If an error occurred, an informational message about the error.

*/ inline void SetMessage(const Aws::String& value) { m_message = value; } /** *

If an error occurred, an informational message about the error.

*/ inline void SetMessage(Aws::String&& value) { m_message = std::move(value); } /** *

If an error occurred, an informational message about the error.

*/ inline void SetMessage(const char* value) { m_message.assign(value); } /** *

If an error occurred, an informational message about the error.

*/ inline DescribeForecastResult& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** *

If an error occurred, an informational message about the error.

*/ inline DescribeForecastResult& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** *

If an error occurred, an informational message about the error.

*/ inline DescribeForecastResult& WithMessage(const char* value) { SetMessage(value); return *this;} /** *

When the forecast creation task was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

When the forecast creation task was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTime = value; } /** *

When the forecast creation task was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTime = std::move(value); } /** *

When the forecast creation task was created.

*/ inline DescribeForecastResult& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

When the forecast creation task was created.

*/ inline DescribeForecastResult& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The last time the resource was modified. The timestamp depends on the status * of the job:

  • CREATE_PENDING - The * CreationTime.

  • CREATE_IN_PROGRESS - * The current timestamp.

  • CREATE_STOPPING - The * current timestamp.

  • CREATE_STOPPED - When the job * stopped.

  • ACTIVE or CREATE_FAILED - * When the job finished or failed.

*/ inline const Aws::Utils::DateTime& GetLastModificationTime() const{ return m_lastModificationTime; } /** *

The last time the resource was modified. The timestamp depends on the status * of the job:

  • CREATE_PENDING - The * CreationTime.

  • CREATE_IN_PROGRESS - * The current timestamp.

  • CREATE_STOPPING - The * current timestamp.

  • CREATE_STOPPED - When the job * stopped.

  • ACTIVE or CREATE_FAILED - * When the job finished or failed.

*/ inline void SetLastModificationTime(const Aws::Utils::DateTime& value) { m_lastModificationTime = value; } /** *

The last time the resource was modified. The timestamp depends on the status * of the job:

  • CREATE_PENDING - The * CreationTime.

  • CREATE_IN_PROGRESS - * The current timestamp.

  • CREATE_STOPPING - The * current timestamp.

  • CREATE_STOPPED - When the job * stopped.

  • ACTIVE or CREATE_FAILED - * When the job finished or failed.

*/ inline void SetLastModificationTime(Aws::Utils::DateTime&& value) { m_lastModificationTime = std::move(value); } /** *

The last time the resource was modified. The timestamp depends on the status * of the job:

  • CREATE_PENDING - The * CreationTime.

  • CREATE_IN_PROGRESS - * The current timestamp.

  • CREATE_STOPPING - The * current timestamp.

  • CREATE_STOPPED - When the job * stopped.

  • ACTIVE or CREATE_FAILED - * When the job finished or failed.

*/ inline DescribeForecastResult& WithLastModificationTime(const Aws::Utils::DateTime& value) { SetLastModificationTime(value); return *this;} /** *

The last time the resource was modified. The timestamp depends on the status * of the job:

  • CREATE_PENDING - The * CreationTime.

  • CREATE_IN_PROGRESS - * The current timestamp.

  • CREATE_STOPPING - The * current timestamp.

  • CREATE_STOPPED - When the job * stopped.

  • ACTIVE or CREATE_FAILED - * When the job finished or failed.

*/ inline DescribeForecastResult& WithLastModificationTime(Aws::Utils::DateTime&& value) { SetLastModificationTime(std::move(value)); return *this;} /** *

The time series to include in the forecast.

*/ inline const TimeSeriesSelector& GetTimeSeriesSelector() const{ return m_timeSeriesSelector; } /** *

The time series to include in the forecast.

*/ inline void SetTimeSeriesSelector(const TimeSeriesSelector& value) { m_timeSeriesSelector = value; } /** *

The time series to include in the forecast.

*/ inline void SetTimeSeriesSelector(TimeSeriesSelector&& value) { m_timeSeriesSelector = std::move(value); } /** *

The time series to include in the forecast.

*/ inline DescribeForecastResult& WithTimeSeriesSelector(const TimeSeriesSelector& value) { SetTimeSeriesSelector(value); return *this;} /** *

The time series to include in the forecast.

*/ inline DescribeForecastResult& WithTimeSeriesSelector(TimeSeriesSelector&& value) { SetTimeSeriesSelector(std::move(value)); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeForecastResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeForecastResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeForecastResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_forecastArn; Aws::String m_forecastName; Aws::Vector m_forecastTypes; Aws::String m_predictorArn; Aws::String m_datasetGroupArn; long long m_estimatedTimeRemainingInMinutes; Aws::String m_status; Aws::String m_message; Aws::Utils::DateTime m_creationTime; Aws::Utils::DateTime m_lastModificationTime; TimeSeriesSelector m_timeSeriesSelector; Aws::String m_requestId; }; } // namespace Model } // namespace ForecastService } // namespace Aws