/** * 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 #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace ForecastService { namespace Model { class DescribeDatasetResult { public: AWS_FORECASTSERVICE_API DescribeDatasetResult(); AWS_FORECASTSERVICE_API DescribeDatasetResult(const Aws::AmazonWebServiceResult& result); AWS_FORECASTSERVICE_API DescribeDatasetResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The Amazon Resource Name (ARN) of the dataset.

*/ inline const Aws::String& GetDatasetArn() const{ return m_datasetArn; } /** *

The Amazon Resource Name (ARN) of the dataset.

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

The Amazon Resource Name (ARN) of the dataset.

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

The Amazon Resource Name (ARN) of the dataset.

*/ inline void SetDatasetArn(const char* value) { m_datasetArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the dataset.

*/ inline DescribeDatasetResult& WithDatasetArn(const Aws::String& value) { SetDatasetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset.

*/ inline DescribeDatasetResult& WithDatasetArn(Aws::String&& value) { SetDatasetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the dataset.

*/ inline DescribeDatasetResult& WithDatasetArn(const char* value) { SetDatasetArn(value); return *this;} /** *

The name of the dataset.

*/ inline const Aws::String& GetDatasetName() const{ return m_datasetName; } /** *

The name of the dataset.

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

The name of the dataset.

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

The name of the dataset.

*/ inline void SetDatasetName(const char* value) { m_datasetName.assign(value); } /** *

The name of the dataset.

*/ inline DescribeDatasetResult& WithDatasetName(const Aws::String& value) { SetDatasetName(value); return *this;} /** *

The name of the dataset.

*/ inline DescribeDatasetResult& WithDatasetName(Aws::String&& value) { SetDatasetName(std::move(value)); return *this;} /** *

The name of the dataset.

*/ inline DescribeDatasetResult& WithDatasetName(const char* value) { SetDatasetName(value); return *this;} /** *

The domain associated with the dataset.

*/ inline const Domain& GetDomain() const{ return m_domain; } /** *

The domain associated with the dataset.

*/ inline void SetDomain(const Domain& value) { m_domain = value; } /** *

The domain associated with the dataset.

*/ inline void SetDomain(Domain&& value) { m_domain = std::move(value); } /** *

The domain associated with the dataset.

*/ inline DescribeDatasetResult& WithDomain(const Domain& value) { SetDomain(value); return *this;} /** *

The domain associated with the dataset.

*/ inline DescribeDatasetResult& WithDomain(Domain&& value) { SetDomain(std::move(value)); return *this;} /** *

The dataset type.

*/ inline const DatasetType& GetDatasetType() const{ return m_datasetType; } /** *

The dataset type.

*/ inline void SetDatasetType(const DatasetType& value) { m_datasetType = value; } /** *

The dataset type.

*/ inline void SetDatasetType(DatasetType&& value) { m_datasetType = std::move(value); } /** *

The dataset type.

*/ inline DescribeDatasetResult& WithDatasetType(const DatasetType& value) { SetDatasetType(value); return *this;} /** *

The dataset type.

*/ inline DescribeDatasetResult& WithDatasetType(DatasetType&& value) { SetDatasetType(std::move(value)); return *this;} /** *

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

*/ inline const Aws::String& GetDataFrequency() const{ return m_dataFrequency; } /** *

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

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

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

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

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

*/ inline void SetDataFrequency(const char* value) { m_dataFrequency.assign(value); } /** *

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

*/ inline DescribeDatasetResult& WithDataFrequency(const Aws::String& value) { SetDataFrequency(value); return *this;} /** *

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

*/ inline DescribeDatasetResult& WithDataFrequency(Aws::String&& value) { SetDataFrequency(std::move(value)); return *this;} /** *

The frequency of data collection.

Valid intervals are Y (Year), M * (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), * 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" * indicates every month and "30min" indicates every 30 minutes.

*/ inline DescribeDatasetResult& WithDataFrequency(const char* value) { SetDataFrequency(value); return *this;} /** *

An array of SchemaAttribute objects that specify the dataset * fields. Each SchemaAttribute specifies the name and data type of a * field.

*/ inline const Schema& GetSchema() const{ return m_schema; } /** *

An array of SchemaAttribute objects that specify the dataset * fields. Each SchemaAttribute specifies the name and data type of a * field.

*/ inline void SetSchema(const Schema& value) { m_schema = value; } /** *

An array of SchemaAttribute objects that specify the dataset * fields. Each SchemaAttribute specifies the name and data type of a * field.

*/ inline void SetSchema(Schema&& value) { m_schema = std::move(value); } /** *

An array of SchemaAttribute objects that specify the dataset * fields. Each SchemaAttribute specifies the name and data type of a * field.

*/ inline DescribeDatasetResult& WithSchema(const Schema& value) { SetSchema(value); return *this;} /** *

An array of SchemaAttribute objects that specify the dataset * fields. Each SchemaAttribute specifies the name and data type of a * field.

*/ inline DescribeDatasetResult& WithSchema(Schema&& value) { SetSchema(std::move(value)); return *this;} /** *

The Key Management Service (KMS) key and the Identity and Access Management * (IAM) role that Amazon Forecast can assume to access the key.

*/ inline const EncryptionConfig& GetEncryptionConfig() const{ return m_encryptionConfig; } /** *

The Key Management Service (KMS) key and the Identity and Access Management * (IAM) role that Amazon Forecast can assume to access the key.

*/ inline void SetEncryptionConfig(const EncryptionConfig& value) { m_encryptionConfig = value; } /** *

The Key Management Service (KMS) key and the Identity and Access Management * (IAM) role that Amazon Forecast can assume to access the key.

*/ inline void SetEncryptionConfig(EncryptionConfig&& value) { m_encryptionConfig = std::move(value); } /** *

The Key Management Service (KMS) key and the Identity and Access Management * (IAM) role that Amazon Forecast can assume to access the key.

*/ inline DescribeDatasetResult& WithEncryptionConfig(const EncryptionConfig& value) { SetEncryptionConfig(value); return *this;} /** *

The Key Management Service (KMS) key and the Identity and Access Management * (IAM) role that Amazon Forecast can assume to access the key.

*/ inline DescribeDatasetResult& WithEncryptionConfig(EncryptionConfig&& value) { SetEncryptionConfig(std::move(value)); return *this;} /** *

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

The status of the dataset. States include:

  • * ACTIVE

  • CREATE_PENDING, * CREATE_IN_PROGRESS, CREATE_FAILED

  • * DELETE_PENDING, DELETE_IN_PROGRESS, * DELETE_FAILED

  • UPDATE_PENDING, * UPDATE_IN_PROGRESS, UPDATE_FAILED

*

The UPDATE states apply while data is imported to the dataset * from a call to the CreateDatasetImportJob * operation and reflect the status of the dataset import job. For example, when * the import job status is CREATE_IN_PROGRESS, the status of the * dataset is UPDATE_IN_PROGRESS.

The * Status of the dataset must be ACTIVE before you can * import training data.

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

When the dataset was created.

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

When the dataset was created.

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

When the dataset was created.

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

When the dataset was created.

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

When the dataset was created.

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

When you create a dataset, LastModificationTime is the same as * CreationTime. While data is being imported to the dataset, * LastModificationTime is the current time of the * DescribeDataset call. After a CreateDatasetImportJob * operation has finished, LastModificationTime is when the import job * completed or failed.

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

When you create a dataset, LastModificationTime is the same as * CreationTime. While data is being imported to the dataset, * LastModificationTime is the current time of the * DescribeDataset call. After a CreateDatasetImportJob * operation has finished, LastModificationTime is when the import job * completed or failed.

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

When you create a dataset, LastModificationTime is the same as * CreationTime. While data is being imported to the dataset, * LastModificationTime is the current time of the * DescribeDataset call. After a CreateDatasetImportJob * operation has finished, LastModificationTime is when the import job * completed or failed.

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

When you create a dataset, LastModificationTime is the same as * CreationTime. While data is being imported to the dataset, * LastModificationTime is the current time of the * DescribeDataset call. After a CreateDatasetImportJob * operation has finished, LastModificationTime is when the import job * completed or failed.

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

When you create a dataset, LastModificationTime is the same as * CreationTime. While data is being imported to the dataset, * LastModificationTime is the current time of the * DescribeDataset call. After a CreateDatasetImportJob * operation has finished, LastModificationTime is when the import job * completed or failed.

*/ inline DescribeDatasetResult& 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 DescribeDatasetResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeDatasetResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeDatasetResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_datasetArn; Aws::String m_datasetName; Domain m_domain; DatasetType m_datasetType; Aws::String m_dataFrequency; Schema m_schema; EncryptionConfig m_encryptionConfig; Aws::String m_status; Aws::Utils::DateTime m_creationTime; Aws::Utils::DateTime m_lastModificationTime; Aws::String m_requestId; }; } // namespace Model } // namespace ForecastService } // namespace Aws