This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files

408 lines
15 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/personalize/Personalize_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/DateTime.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Personalize
{
namespace Model
{
/**
* <p>A dataset group is a collection of related datasets (Interactions, User, and
* Item). You create a dataset group by calling <a>CreateDatasetGroup</a>. You then
* create a dataset and add it to a dataset group by calling <a>CreateDataset</a>.
* The dataset group is used to create and train a solution by calling
* <a>CreateSolution</a>. A dataset group can contain only one of each type of
* dataset.</p> <p>You can specify an AWS Key Management Service (KMS) key to
* encrypt the datasets in the group.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroup">AWS
* API Reference</a></p>
*/
class AWS_PERSONALIZE_API DatasetGroup
{
public:
DatasetGroup();
DatasetGroup(Aws::Utils::Json::JsonView jsonValue);
DatasetGroup& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name of the dataset group.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the dataset group.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the dataset group.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the dataset group.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the dataset group.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the dataset group.</p>
*/
inline DatasetGroup& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the dataset group.</p>
*/
inline DatasetGroup& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the dataset group.</p>
*/
inline DatasetGroup& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline const Aws::String& GetDatasetGroupArn() const{ return m_datasetGroupArn; }
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline bool DatasetGroupArnHasBeenSet() const { return m_datasetGroupArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline void SetDatasetGroupArn(const Aws::String& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline void SetDatasetGroupArn(Aws::String&& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline void SetDatasetGroupArn(const char* value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline DatasetGroup& WithDatasetGroupArn(const Aws::String& value) { SetDatasetGroupArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline DatasetGroup& WithDatasetGroupArn(Aws::String&& value) { SetDatasetGroupArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the dataset group.</p>
*/
inline DatasetGroup& WithDatasetGroupArn(const char* value) { SetDatasetGroupArn(value); return *this;}
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline const Aws::String& GetStatus() const{ return m_status; }
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); }
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline DatasetGroup& WithStatus(const Aws::String& value) { SetStatus(value); return *this;}
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline DatasetGroup& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;}
/**
* <p>The current status of the dataset group.</p> <p>A dataset group can be in one
* of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS
* &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>
*/
inline DatasetGroup& WithStatus(const char* value) { SetStatus(value); return *this;}
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline DatasetGroup& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline DatasetGroup& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
/**
* <p>The ARN of the IAM role that has permissions to create the dataset group.</p>
*/
inline DatasetGroup& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline const Aws::String& GetKmsKeyArn() const{ return m_kmsKeyArn; }
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline bool KmsKeyArnHasBeenSet() const { return m_kmsKeyArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline void SetKmsKeyArn(const Aws::String& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline void SetKmsKeyArn(Aws::String&& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline void SetKmsKeyArn(const char* value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline DatasetGroup& WithKmsKeyArn(const Aws::String& value) { SetKmsKeyArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline DatasetGroup& WithKmsKeyArn(Aws::String&& value) { SetKmsKeyArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the
* datasets.</p>
*/
inline DatasetGroup& WithKmsKeyArn(const char* value) { SetKmsKeyArn(value); return *this;}
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline const Aws::Utils::DateTime& GetCreationDateTime() const{ return m_creationDateTime; }
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline bool CreationDateTimeHasBeenSet() const { return m_creationDateTimeHasBeenSet; }
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline void SetCreationDateTime(const Aws::Utils::DateTime& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = value; }
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline void SetCreationDateTime(Aws::Utils::DateTime&& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = std::move(value); }
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline DatasetGroup& WithCreationDateTime(const Aws::Utils::DateTime& value) { SetCreationDateTime(value); return *this;}
/**
* <p>The creation date and time (in Unix time) of the dataset group.</p>
*/
inline DatasetGroup& WithCreationDateTime(Aws::Utils::DateTime&& value) { SetCreationDateTime(std::move(value)); return *this;}
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline const Aws::Utils::DateTime& GetLastUpdatedDateTime() const{ return m_lastUpdatedDateTime; }
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline bool LastUpdatedDateTimeHasBeenSet() const { return m_lastUpdatedDateTimeHasBeenSet; }
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline void SetLastUpdatedDateTime(const Aws::Utils::DateTime& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = value; }
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline void SetLastUpdatedDateTime(Aws::Utils::DateTime&& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = std::move(value); }
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline DatasetGroup& WithLastUpdatedDateTime(const Aws::Utils::DateTime& value) { SetLastUpdatedDateTime(value); return *this;}
/**
* <p>The last update date and time (in Unix time) of the dataset group.</p>
*/
inline DatasetGroup& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); return *this;}
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline const Aws::String& GetFailureReason() const{ return m_failureReason; }
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; }
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; }
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); }
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); }
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline DatasetGroup& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;}
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline DatasetGroup& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;}
/**
* <p>If creating a dataset group fails, provides the reason why.</p>
*/
inline DatasetGroup& WithFailureReason(const char* value) { SetFailureReason(value); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
Aws::String m_datasetGroupArn;
bool m_datasetGroupArnHasBeenSet;
Aws::String m_status;
bool m_statusHasBeenSet;
Aws::String m_roleArn;
bool m_roleArnHasBeenSet;
Aws::String m_kmsKeyArn;
bool m_kmsKeyArnHasBeenSet;
Aws::Utils::DateTime m_creationDateTime;
bool m_creationDateTimeHasBeenSet;
Aws::Utils::DateTime m_lastUpdatedDateTime;
bool m_lastUpdatedDateTimeHasBeenSet;
Aws::String m_failureReason;
bool m_failureReasonHasBeenSet;
};
} // namespace Model
} // namespace Personalize
} // namespace Aws