/** * 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 { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ComprehendMedical { namespace Model { /** *

Provides information about a detection job.

See Also:

AWS * API Reference

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

The identifier assigned to the detection job.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The identifier assigned to the detection job.

*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *

The identifier assigned to the detection job.

*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *

The identifier assigned to the detection job.

*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *

The identifier assigned to the detection job.

*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *

The identifier assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The identifier assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The identifier assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobId(const char* value) { SetJobId(value); return *this;} /** *

The name that you assigned to the detection job.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

The name that you assigned to the detection job.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

The name that you assigned to the detection job.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

The name that you assigned to the detection job.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

The name that you assigned to the detection job.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

The name that you assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

The name that you assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

The name that you assigned to the detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline const JobStatus& GetJobStatus() const{ return m_jobStatus; } /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; } /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline void SetJobStatus(const JobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; } /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline void SetJobStatus(JobStatus&& value) { m_jobStatusHasBeenSet = true; m_jobStatus = std::move(value); } /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} /** *

The current status of the detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline ComprehendMedicalAsyncJobProperties& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;} /** *

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

The time that the detection job was submitted for processing.

*/ inline const Aws::Utils::DateTime& GetSubmitTime() const{ return m_submitTime; } /** *

The time that the detection job was submitted for processing.

*/ inline bool SubmitTimeHasBeenSet() const { return m_submitTimeHasBeenSet; } /** *

The time that the detection job was submitted for processing.

*/ inline void SetSubmitTime(const Aws::Utils::DateTime& value) { m_submitTimeHasBeenSet = true; m_submitTime = value; } /** *

The time that the 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 detection job was submitted for processing.

*/ inline ComprehendMedicalAsyncJobProperties& WithSubmitTime(const Aws::Utils::DateTime& value) { SetSubmitTime(value); return *this;} /** *

The time that the detection job was submitted for processing.

*/ inline ComprehendMedicalAsyncJobProperties& WithSubmitTime(Aws::Utils::DateTime&& value) { SetSubmitTime(std::move(value)); return *this;} /** *

The time that the detection job completed.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

The time that the detection job completed.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

The time that the detection job completed.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

The time that the detection job completed.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

The time that the detection job completed.

*/ inline ComprehendMedicalAsyncJobProperties& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

The time that the detection job completed.

*/ inline ComprehendMedicalAsyncJobProperties& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline const Aws::Utils::DateTime& GetExpirationTime() const{ return m_expirationTime; } /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline bool ExpirationTimeHasBeenSet() const { return m_expirationTimeHasBeenSet; } /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline void SetExpirationTime(const Aws::Utils::DateTime& value) { m_expirationTimeHasBeenSet = true; m_expirationTime = value; } /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline void SetExpirationTime(Aws::Utils::DateTime&& value) { m_expirationTimeHasBeenSet = true; m_expirationTime = std::move(value); } /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline ComprehendMedicalAsyncJobProperties& WithExpirationTime(const Aws::Utils::DateTime& value) { SetExpirationTime(value); return *this;} /** *

The date and time that job metadata is deleted from the server. Output files * in your S3 bucket will not be deleted. After the metadata is deleted, the job * will no longer appear in the results of the * ListEntitiesDetectionV2Job or the ListPHIDetectionJobs * operation.

*/ inline ComprehendMedicalAsyncJobProperties& WithExpirationTime(Aws::Utils::DateTime&& value) { SetExpirationTime(std::move(value)); return *this;} /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline const InputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; } /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; } /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline void SetInputDataConfig(const InputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; } /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline void SetInputDataConfig(InputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); } /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline ComprehendMedicalAsyncJobProperties& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

The input data configuration that you supplied when you created the detection * job.

*/ inline ComprehendMedicalAsyncJobProperties& WithInputDataConfig(InputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;} /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline const OutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; } /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; } /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline void SetOutputDataConfig(const OutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; } /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline void SetOutputDataConfig(OutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); } /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithOutputDataConfig(const OutputDataConfig& value) { SetOutputDataConfig(value); return *this;} /** *

The output data configuration that you supplied when you created the * detection job.

*/ inline ComprehendMedicalAsyncJobProperties& WithOutputDataConfig(OutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;} /** *

The language code of the input documents.

*/ inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

The language code of the input documents.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The language code of the input documents.

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The language code of the input documents.

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The language code of the input documents.

*/ inline ComprehendMedicalAsyncJobProperties& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

The language code of the input documents.

*/ inline ComprehendMedicalAsyncJobProperties& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; } /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; } /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); } /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline ComprehendMedicalAsyncJobProperties& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline ComprehendMedicalAsyncJobProperties& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read * access to your input data.

*/ inline ComprehendMedicalAsyncJobProperties& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *

The path to the file that describes the results of a batch job.

*/ inline const Aws::String& GetManifestFilePath() const{ return m_manifestFilePath; } /** *

The path to the file that describes the results of a batch job.

*/ inline bool ManifestFilePathHasBeenSet() const { return m_manifestFilePathHasBeenSet; } /** *

The path to the file that describes the results of a batch job.

*/ inline void SetManifestFilePath(const Aws::String& value) { m_manifestFilePathHasBeenSet = true; m_manifestFilePath = value; } /** *

The path to the file that describes the results of a batch job.

*/ inline void SetManifestFilePath(Aws::String&& value) { m_manifestFilePathHasBeenSet = true; m_manifestFilePath = std::move(value); } /** *

The path to the file that describes the results of a batch job.

*/ inline void SetManifestFilePath(const char* value) { m_manifestFilePathHasBeenSet = true; m_manifestFilePath.assign(value); } /** *

The path to the file that describes the results of a batch job.

*/ inline ComprehendMedicalAsyncJobProperties& WithManifestFilePath(const Aws::String& value) { SetManifestFilePath(value); return *this;} /** *

The path to the file that describes the results of a batch job.

*/ inline ComprehendMedicalAsyncJobProperties& WithManifestFilePath(Aws::String&& value) { SetManifestFilePath(std::move(value)); return *this;} /** *

The path to the file that describes the results of a batch job.

*/ inline ComprehendMedicalAsyncJobProperties& WithManifestFilePath(const char* value) { SetManifestFilePath(value); return *this;} /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline ComprehendMedicalAsyncJobProperties& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline ComprehendMedicalAsyncJobProperties& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** *

The AWS Key Management Service key, if any, used to encrypt the output files. *

*/ inline ComprehendMedicalAsyncJobProperties& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline const Aws::String& GetModelVersion() const{ return m_modelVersion; } /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline bool ModelVersionHasBeenSet() const { return m_modelVersionHasBeenSet; } /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline void SetModelVersion(const Aws::String& value) { m_modelVersionHasBeenSet = true; m_modelVersion = value; } /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline void SetModelVersion(Aws::String&& value) { m_modelVersionHasBeenSet = true; m_modelVersion = std::move(value); } /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline void SetModelVersion(const char* value) { m_modelVersionHasBeenSet = true; m_modelVersion.assign(value); } /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline ComprehendMedicalAsyncJobProperties& WithModelVersion(const Aws::String& value) { SetModelVersion(value); return *this;} /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline ComprehendMedicalAsyncJobProperties& WithModelVersion(Aws::String&& value) { SetModelVersion(std::move(value)); return *this;} /** *

The version of the model used to analyze the documents. The version number * looks like X.X.X. You can use this information to track the model used for a * particular batch of documents.

*/ inline ComprehendMedicalAsyncJobProperties& WithModelVersion(const char* value) { SetModelVersion(value); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = 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; Aws::Utils::DateTime m_expirationTime; bool m_expirationTimeHasBeenSet = false; InputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet = false; OutputDataConfig m_outputDataConfig; bool m_outputDataConfigHasBeenSet = false; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet = false; Aws::String m_manifestFilePath; bool m_manifestFilePathHasBeenSet = false; Aws::String m_kMSKey; bool m_kMSKeyHasBeenSet = false; Aws::String m_modelVersion; bool m_modelVersionHasBeenSet = false; }; } // namespace Model } // namespace ComprehendMedical } // namespace Aws