/** * 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 a summary of the Explainability properties used in the * ListExplainabilities operation. To get a complete set of properties, call * the DescribeExplainability operation, and provide the listed * ExplainabilityArn.

See Also:

AWS * API Reference

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

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 bool ExplainabilityArnHasBeenSet() const { return m_explainabilityArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

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

The Amazon Resource Name (ARN) of the Explainability.

*/ inline ExplainabilitySummary& 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 bool ExplainabilityNameHasBeenSet() const { return m_explainabilityNameHasBeenSet; } /** *

The name of the Explainability.

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

The name of the Explainability.

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

The name of the Explainability.

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

The name of the Explainability.

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

The name of the Explainability.

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

The name of the Explainability.

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

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

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

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

*/ inline bool ResourceArnHasBeenSet() const { return m_resourceArnHasBeenSet; } /** *

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

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

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

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

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

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

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

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

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

*/ inline ExplainabilitySummary& 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.

*/ inline ExplainabilitySummary& 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 bool ExplainabilityConfigHasBeenSet() const { return m_explainabilityConfigHasBeenSet; } /** *

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

*/ inline void SetExplainabilityConfig(const ExplainabilityConfig& value) { m_explainabilityConfigHasBeenSet = true; 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_explainabilityConfigHasBeenSet = true; m_explainabilityConfig = std::move(value); } /** *

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

*/ inline ExplainabilitySummary& 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 ExplainabilitySummary& WithExplainabilityConfig(ExplainabilityConfig&& value) { SetExplainabilityConfig(std::move(value)); return *this;} /** *

The status of the Explainability. 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. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the Explainability. 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_statusHasBeenSet = true; m_status = value; } /** *

The status of the Explainability. 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_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the Explainability. 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_statusHasBeenSet = true; m_status.assign(value); } /** *

The status of the Explainability. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

The status of the Explainability. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * CREATE_STOPPING, CREATE_STOPPED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

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

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

*/ inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

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

Information about any errors that may have occurred during the Explainability * creation process.

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

When the Explainability was created.

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

When the Explainability was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

When the Explainability was created.

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

When the Explainability was created.

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

When the Explainability was created.

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

When the Explainability was created.

*/ inline ExplainabilitySummary& 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 ExplainabilitySummary& 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 ExplainabilitySummary& WithLastModificationTime(Aws::Utils::DateTime&& value) { SetLastModificationTime(std::move(value)); return *this;} private: Aws::String m_explainabilityArn; bool m_explainabilityArnHasBeenSet = false; Aws::String m_explainabilityName; bool m_explainabilityNameHasBeenSet = false; Aws::String m_resourceArn; bool m_resourceArnHasBeenSet = false; ExplainabilityConfig m_explainabilityConfig; bool m_explainabilityConfigHasBeenSet = 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