/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Provides information about a topic detection job.See Also:
* AWS
* API Reference
The identifier assigned to the topic detection job.
*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *The identifier assigned to the topic detection job.
*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *The identifier assigned to the topic detection job.
*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *The identifier assigned to the topic detection job.
*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *The identifier assigned to the topic detection job.
*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *The identifier assigned to the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *The identifier assigned to the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *The identifier assigned to the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobId(const char* value) { SetJobId(value); return *this;} /** *The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, * fully qualified identifier for the job. It includes the Amazon Web Services * account, Amazon Web Services Region, and the job ID. The format of the ARN is as * follows:
* arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
*
The following is an example job ARN:
* arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
*
The name of the topic detection job.
*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *The name of the topic detection job.
*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *The name of the topic detection job.
*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *The name of the topic detection job.
*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *The name of the topic detection job.
*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *The name of the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *The name of the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *The name of the topic detection job.
*/ inline TopicsDetectionJobProperties& WithJobName(const char* value) { SetJobName(value); return *this;} /** *The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
The current status of the topic detection job. If the status is
* Failed
, the reason for the failure is shown in the
* Message
field.
A description for the status of a job.
*/ inline const Aws::String& GetMessage() const{ return m_message; } /** *A description for the status of a job.
*/ inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *A description for the status of a job.
*/ inline void SetMessage(const Aws::String& value) { m_messageHasBeenSet = true; m_message = value; } /** *A description for the status of a job.
*/ inline void SetMessage(Aws::String&& value) { m_messageHasBeenSet = true; m_message = std::move(value); } /** *A description for the status of a job.
*/ inline void SetMessage(const char* value) { m_messageHasBeenSet = true; m_message.assign(value); } /** *A description for the status of a job.
*/ inline TopicsDetectionJobProperties& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** *A description for the status of a job.
*/ inline TopicsDetectionJobProperties& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** *A description for the status of a job.
*/ inline TopicsDetectionJobProperties& WithMessage(const char* value) { SetMessage(value); return *this;} /** *The time that the topic detection job was submitted for processing.
*/ inline const Aws::Utils::DateTime& GetSubmitTime() const{ return m_submitTime; } /** *The time that the topic detection job was submitted for processing.
*/ inline bool SubmitTimeHasBeenSet() const { return m_submitTimeHasBeenSet; } /** *The time that the topic detection job was submitted for processing.
*/ inline void SetSubmitTime(const Aws::Utils::DateTime& value) { m_submitTimeHasBeenSet = true; m_submitTime = value; } /** *The time that the topic detection job was submitted for processing.
*/ inline void SetSubmitTime(Aws::Utils::DateTime&& value) { m_submitTimeHasBeenSet = true; m_submitTime = std::move(value); } /** *The time that the topic detection job was submitted for processing.
*/ inline TopicsDetectionJobProperties& WithSubmitTime(const Aws::Utils::DateTime& value) { SetSubmitTime(value); return *this;} /** *The time that the topic detection job was submitted for processing.
*/ inline TopicsDetectionJobProperties& WithSubmitTime(Aws::Utils::DateTime&& value) { SetSubmitTime(std::move(value)); return *this;} /** *The time that the topic detection job was completed.
*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *The time that the topic detection job was completed.
*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *The time that the topic detection job was completed.
*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *The time that the topic detection job was completed.
*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *The time that the topic detection job was completed.
*/ inline TopicsDetectionJobProperties& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *The time that the topic detection job was completed.
*/ inline TopicsDetectionJobProperties& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *The input data configuration supplied when you created the topic detection * job.
*/ inline const InputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; } /** *The input data configuration supplied when you created the topic detection * job.
*/ inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; } /** *The input data configuration supplied when you created the topic detection * job.
*/ inline void SetInputDataConfig(const InputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; } /** *The input data configuration supplied when you created the topic detection * job.
*/ inline void SetInputDataConfig(InputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); } /** *The input data configuration supplied when you created the topic detection * job.
*/ inline TopicsDetectionJobProperties& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *The input data configuration supplied when you created the topic detection * job.
*/ inline TopicsDetectionJobProperties& WithInputDataConfig(InputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;} /** *The output data configuration supplied when you created the topic detection * job.
*/ inline const OutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; } /** *The output data configuration supplied when you created the topic detection * job.
*/ inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; } /** *The output data configuration supplied when you created the topic detection * job.
*/ inline void SetOutputDataConfig(const OutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; } /** *The output data configuration supplied when you created the topic detection * job.
*/ inline void SetOutputDataConfig(OutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); } /** *The output data configuration supplied when you created the topic detection * job.
*/ inline TopicsDetectionJobProperties& WithOutputDataConfig(const OutputDataConfig& value) { SetOutputDataConfig(value); return *this;} /** *The output data configuration supplied when you created the topic detection * job.
*/ inline TopicsDetectionJobProperties& WithOutputDataConfig(OutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;} /** *The number of topics to detect supplied when you created the topic detection * job. The default is 10.
*/ inline int GetNumberOfTopics() const{ return m_numberOfTopics; } /** *The number of topics to detect supplied when you created the topic detection * job. The default is 10.
*/ inline bool NumberOfTopicsHasBeenSet() const { return m_numberOfTopicsHasBeenSet; } /** *The number of topics to detect supplied when you created the topic detection * job. The default is 10.
*/ inline void SetNumberOfTopics(int value) { m_numberOfTopicsHasBeenSet = true; m_numberOfTopics = value; } /** *The number of topics to detect supplied when you created the topic detection * job. The default is 10.
*/ inline TopicsDetectionJobProperties& WithNumberOfTopics(int value) { SetNumberOfTopics(value); return *this;} /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; } /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; } /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; } /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); } /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); } /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline TopicsDetectionJobProperties& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;} /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline TopicsDetectionJobProperties& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to your job data.
*/ inline TopicsDetectionJobProperties& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt data on the storage volume attached to the ML compute * instance(s) that process the analysis job. The VolumeKmsKeyId can be either of * the following formats:
KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon
* Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline const VpcConfig& GetVpcConfig() const{ return m_vpcConfig; } /** *Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; } /** *Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline void SetVpcConfig(const VpcConfig& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = value; } /** *Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline void SetVpcConfig(VpcConfig&& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = std::move(value); } /** *Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline TopicsDetectionJobProperties& WithVpcConfig(const VpcConfig& value) { SetVpcConfig(value); return *this;} /** *Configuration parameters for a private Virtual Private Cloud (VPC) containing * the resources you are using for your topic detection job. For more information, * see Amazon * VPC.
*/ inline TopicsDetectionJobProperties& WithVpcConfig(VpcConfig&& value) { SetVpcConfig(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; Aws::String m_jobArn; bool m_jobArnHasBeenSet = false; Aws::String m_jobName; bool m_jobNameHasBeenSet = false; JobStatus m_jobStatus; bool m_jobStatusHasBeenSet = false; Aws::String m_message; bool m_messageHasBeenSet = false; Aws::Utils::DateTime m_submitTime; bool m_submitTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; InputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet = false; OutputDataConfig m_outputDataConfig; bool m_outputDataConfigHasBeenSet = false; int m_numberOfTopics; bool m_numberOfTopicsHasBeenSet = false; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet = false; Aws::String m_volumeKmsKeyId; bool m_volumeKmsKeyIdHasBeenSet = false; VpcConfig m_vpcConfig; bool m_vpcConfigHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws