/** * 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 { /** *

Provides a summary of the forecast properties used in the * ListForecasts operation. To get the complete set of properties, call the * DescribeForecast operation, and provide the ForecastArn that * is listed in the summary.

See Also:

AWS * API Reference

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

The ARN of the forecast.

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

The ARN of the forecast.

*/ inline bool ForecastArnHasBeenSet() const { return m_forecastArnHasBeenSet; } /** *

The ARN of the forecast.

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

The ARN of the forecast.

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

The ARN of the forecast.

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

The ARN of the forecast.

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

The ARN of the forecast.

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

The ARN of the forecast.

*/ inline ForecastSummary& 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 bool ForecastNameHasBeenSet() const { return m_forecastNameHasBeenSet; } /** *

The name of the forecast.

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

The name of the forecast.

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

The name of the forecast.

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

The name of the forecast.

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

The name of the forecast.

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

The name of the forecast.

*/ inline ForecastSummary& WithForecastName(const char* value) { SetForecastName(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 bool PredictorArnHasBeenSet() const { return m_predictorArnHasBeenSet; } /** *

The ARN of the predictor used to generate the forecast.

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

The ARN of the predictor used to generate the forecast.

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

The ARN of the predictor used to generate the forecast.

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

The ARN of the predictor used to generate the forecast.

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

The ARN of the predictor used to generate the forecast.

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

The ARN of the predictor used to generate the forecast.

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

Whether the Forecast was created from an AutoPredictor.

*/ inline bool GetCreatedUsingAutoPredictor() const{ return m_createdUsingAutoPredictor; } /** *

Whether the Forecast was created from an AutoPredictor.

*/ inline bool CreatedUsingAutoPredictorHasBeenSet() const { return m_createdUsingAutoPredictorHasBeenSet; } /** *

Whether the Forecast was created from an AutoPredictor.

*/ inline void SetCreatedUsingAutoPredictor(bool value) { m_createdUsingAutoPredictorHasBeenSet = true; m_createdUsingAutoPredictor = value; } /** *

Whether the Forecast was created from an AutoPredictor.

*/ inline ForecastSummary& WithCreatedUsingAutoPredictor(bool value) { SetCreatedUsingAutoPredictor(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

*/ inline bool DatasetGroupArnHasBeenSet() const { return m_datasetGroupArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

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

The Amazon Resource Name (ARN) of the dataset group that provided the data * used to train the predictor.

*/ inline ForecastSummary& WithDatasetGroupArn(const char* value) { SetDatasetGroupArn(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 bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

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_statusHasBeenSet = true; 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_statusHasBeenSet = true; 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_statusHasBeenSet = true; 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 ForecastSummary& 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 ForecastSummary& 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 ForecastSummary& 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 bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *

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

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

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

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

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

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

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

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

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

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

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

*/ inline ForecastSummary& 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 bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

When the forecast creation task was created.

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

When the forecast creation task was created.

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

When the forecast creation task was created.

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

When the forecast creation task was created.

*/ inline ForecastSummary& 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 bool LastModificationTimeHasBeenSet() const { return m_lastModificationTimeHasBeenSet; } /** *

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_lastModificationTimeHasBeenSet = true; 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_lastModificationTimeHasBeenSet = true; 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 ForecastSummary& 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 ForecastSummary& WithLastModificationTime(Aws::Utils::DateTime&& value) { SetLastModificationTime(std::move(value)); return *this;} private: Aws::String m_forecastArn; bool m_forecastArnHasBeenSet = false; Aws::String m_forecastName; bool m_forecastNameHasBeenSet = false; Aws::String m_predictorArn; bool m_predictorArnHasBeenSet = false; bool m_createdUsingAutoPredictor; bool m_createdUsingAutoPredictorHasBeenSet = false; Aws::String m_datasetGroupArn; bool m_datasetGroupArnHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::String m_message; bool m_messageHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_lastModificationTime; bool m_lastModificationTimeHasBeenSet = false; }; } // namespace Model } // namespace ForecastService } // namespace Aws