/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #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 DescribeExplainabilityResult { public: AWS_FORECASTSERVICE_API DescribeExplainabilityResult(); AWS_FORECASTSERVICE_API DescribeExplainabilityResult(const Aws::AmazonWebServiceResult& result); AWS_FORECASTSERVICE_API DescribeExplainabilityResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The Amazon Resource Name (ARN) of the Explainability.

*/ inline const Aws::String& GetExplainabilityArn() const{ return m_explainabilityArn; } /** *

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

*/ inline void SetExplainabilityArn(const char* value) { m_explainabilityArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityArn(const Aws::String& value) { SetExplainabilityArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityArn(Aws::String&& value) { SetExplainabilityArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityArn(const char* value) { SetExplainabilityArn(value); return *this;} /** *

The name of the Explainability.

*/ inline const Aws::String& GetExplainabilityName() const{ return m_explainabilityName; } /** *

The name of the Explainability.

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

The name of the Explainability.

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

The name of the Explainability.

*/ inline void SetExplainabilityName(const char* value) { m_explainabilityName.assign(value); } /** *

The name of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityName(const Aws::String& value) { SetExplainabilityName(value); return *this;} /** *

The name of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityName(Aws::String&& value) { SetExplainabilityName(std::move(value)); return *this;} /** *

The name of the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityName(const char* value) { SetExplainabilityName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

*/ inline const Aws::String& GetResourceArn() const{ return m_resourceArn; } /** *

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

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

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

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

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

*/ inline void SetResourceArn(const char* value) { m_resourceArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

*/ inline DescribeExplainabilityResult& WithResourceArn(const Aws::String& value) { SetResourceArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

*/ inline DescribeExplainabilityResult& WithResourceArn(Aws::String&& value) { SetResourceArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create * the Explainability resource.

*/ inline DescribeExplainabilityResult& WithResourceArn(const char* value) { SetResourceArn(value); return *this;} /** *

The configuration settings that define the granularity of time series and * time points for the Explainability.

*/ inline const ExplainabilityConfig& GetExplainabilityConfig() const{ return m_explainabilityConfig; } /** *

The configuration settings that define the granularity of time series and * time points for the Explainability.

*/ inline void SetExplainabilityConfig(const ExplainabilityConfig& value) { m_explainabilityConfig = value; } /** *

The configuration settings that define the granularity of time series and * time points for the Explainability.

*/ inline void SetExplainabilityConfig(ExplainabilityConfig&& value) { m_explainabilityConfig = std::move(value); } /** *

The configuration settings that define the granularity of time series and * time points for the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityConfig(const ExplainabilityConfig& value) { SetExplainabilityConfig(value); return *this;} /** *

The configuration settings that define the granularity of time series and * time points for the Explainability.

*/ inline DescribeExplainabilityResult& WithExplainabilityConfig(ExplainabilityConfig&& value) { SetExplainabilityConfig(std::move(value)); return *this;} /** *

Whether the visualization was enabled for the Explainability resource.

*/ inline bool GetEnableVisualization() const{ return m_enableVisualization; } /** *

Whether the visualization was enabled for the Explainability resource.

*/ inline void SetEnableVisualization(bool value) { m_enableVisualization = value; } /** *

Whether the visualization was enabled for the Explainability resource.

*/ inline DescribeExplainabilityResult& WithEnableVisualization(bool value) { SetEnableVisualization(value); return *this;} inline const DataSource& GetDataSource() const{ return m_dataSource; } inline void SetDataSource(const DataSource& value) { m_dataSource = value; } inline void SetDataSource(DataSource&& value) { m_dataSource = std::move(value); } inline DescribeExplainabilityResult& WithDataSource(const DataSource& value) { SetDataSource(value); return *this;} inline DescribeExplainabilityResult& WithDataSource(DataSource&& value) { SetDataSource(std::move(value)); return *this;} inline const Schema& GetSchema() const{ return m_schema; } inline void SetSchema(const Schema& value) { m_schema = value; } inline void SetSchema(Schema&& value) { m_schema = std::move(value); } inline DescribeExplainabilityResult& WithSchema(const Schema& value) { SetSchema(value); return *this;} inline DescribeExplainabilityResult& WithSchema(Schema&& value) { SetSchema(std::move(value)); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

*/ inline const Aws::String& GetStartDateTime() const{ return m_startDateTime; } /** *

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

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

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

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

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

*/ inline void SetStartDateTime(const char* value) { m_startDateTime.assign(value); } /** *

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithStartDateTime(const Aws::String& value) { SetStartDateTime(value); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithStartDateTime(Aws::String&& value) { SetStartDateTime(std::move(value)); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * first time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithStartDateTime(const char* value) { SetStartDateTime(value); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

*/ inline const Aws::String& GetEndDateTime() const{ return m_endDateTime; } /** *

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

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

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

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

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

*/ inline void SetEndDateTime(const char* value) { m_endDateTime.assign(value); } /** *

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithEndDateTime(const Aws::String& value) { SetEndDateTime(value); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithEndDateTime(Aws::String&& value) { SetEndDateTime(std::move(value)); return *this;} /** *

If TimePointGranularity is set to SPECIFIC, the * last time point in the Explainability.

*/ inline DescribeExplainabilityResult& WithEndDateTime(const char* value) { SetEndDateTime(value); return *this;} /** *

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

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

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

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

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

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

If an error occurred, a message about the error.

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability resource. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

When the Explainability resource was created.

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

When the Explainability resource was created.

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

When the Explainability resource was created.

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

When the Explainability resource was created.

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

When the Explainability resource was created.

*/ inline DescribeExplainabilityResult& 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 DescribeExplainabilityResult& 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 DescribeExplainabilityResult& WithLastModificationTime(Aws::Utils::DateTime&& value) { SetLastModificationTime(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 DescribeExplainabilityResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeExplainabilityResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeExplainabilityResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_explainabilityArn; Aws::String m_explainabilityName; Aws::String m_resourceArn; ExplainabilityConfig m_explainabilityConfig; bool m_enableVisualization; DataSource m_dataSource; Schema m_schema; Aws::String m_startDateTime; Aws::String m_endDateTime; long long m_estimatedTimeRemainingInMinutes; Aws::String m_message; Aws::String m_status; Aws::Utils::DateTime m_creationTime; Aws::Utils::DateTime m_lastModificationTime; Aws::String m_requestId; }; } // namespace Model } // namespace ForecastService } // namespace Aws