/** * 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 { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace MachineLearning { namespace Model { /** *

Represents the output of a GetBatchPrediction operation and * describes a BatchPrediction.

See Also:

AWS * API Reference

*/ class GetBatchPredictionResult { public: AWS_MACHINELEARNING_API GetBatchPredictionResult(); AWS_MACHINELEARNING_API GetBatchPredictionResult(const Aws::AmazonWebServiceResult& result); AWS_MACHINELEARNING_API GetBatchPredictionResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

*/ inline const Aws::String& GetBatchPredictionId() const{ return m_batchPredictionId; } /** *

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

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

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

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

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

*/ inline void SetBatchPredictionId(const char* value) { m_batchPredictionId.assign(value); } /** *

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

*/ inline GetBatchPredictionResult& WithBatchPredictionId(const Aws::String& value) { SetBatchPredictionId(value); return *this;} /** *

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

*/ inline GetBatchPredictionResult& WithBatchPredictionId(Aws::String&& value) { SetBatchPredictionId(std::move(value)); return *this;} /** *

An ID assigned to the BatchPrediction at creation. This value * should be identical to the value of the BatchPredictionID in the * request.

*/ inline GetBatchPredictionResult& WithBatchPredictionId(const char* value) { SetBatchPredictionId(value); return *this;} /** *

The ID of the MLModel that generated predictions for the * BatchPrediction request.

*/ inline const Aws::String& GetMLModelId() const{ return m_mLModelId; } /** *

The ID of the MLModel that generated predictions for the * BatchPrediction request.

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

The ID of the MLModel that generated predictions for the * BatchPrediction request.

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

The ID of the MLModel that generated predictions for the * BatchPrediction request.

*/ inline void SetMLModelId(const char* value) { m_mLModelId.assign(value); } /** *

The ID of the MLModel that generated predictions for the * BatchPrediction request.

*/ inline GetBatchPredictionResult& WithMLModelId(const Aws::String& value) { SetMLModelId(value); return *this;} /** *

The ID of the MLModel that generated predictions for the * BatchPrediction request.

*/ inline GetBatchPredictionResult& WithMLModelId(Aws::String&& value) { SetMLModelId(std::move(value)); return *this;} /** *

The ID of the MLModel that generated predictions for the * BatchPrediction request.

*/ inline GetBatchPredictionResult& WithMLModelId(const char* value) { SetMLModelId(value); return *this;} /** *

The ID of the DataSource that was used to create the * BatchPrediction.

*/ inline const Aws::String& GetBatchPredictionDataSourceId() const{ return m_batchPredictionDataSourceId; } /** *

The ID of the DataSource that was used to create the * BatchPrediction.

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

The ID of the DataSource that was used to create the * BatchPrediction.

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

The ID of the DataSource that was used to create the * BatchPrediction.

*/ inline void SetBatchPredictionDataSourceId(const char* value) { m_batchPredictionDataSourceId.assign(value); } /** *

The ID of the DataSource that was used to create the * BatchPrediction.

*/ inline GetBatchPredictionResult& WithBatchPredictionDataSourceId(const Aws::String& value) { SetBatchPredictionDataSourceId(value); return *this;} /** *

The ID of the DataSource that was used to create the * BatchPrediction.

*/ inline GetBatchPredictionResult& WithBatchPredictionDataSourceId(Aws::String&& value) { SetBatchPredictionDataSourceId(std::move(value)); return *this;} /** *

The ID of the DataSource that was used to create the * BatchPrediction.

*/ inline GetBatchPredictionResult& WithBatchPredictionDataSourceId(const char* value) { SetBatchPredictionDataSourceId(value); return *this;} /** *

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

*/ inline const Aws::String& GetInputDataLocationS3() const{ return m_inputDataLocationS3; } /** *

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

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

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

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

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

*/ inline void SetInputDataLocationS3(const char* value) { m_inputDataLocationS3.assign(value); } /** *

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

*/ inline GetBatchPredictionResult& WithInputDataLocationS3(const Aws::String& value) { SetInputDataLocationS3(value); return *this;} /** *

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

*/ inline GetBatchPredictionResult& WithInputDataLocationS3(Aws::String&& value) { SetInputDataLocationS3(std::move(value)); return *this;} /** *

The location of the data file or directory in Amazon Simple Storage Service * (Amazon S3).

*/ inline GetBatchPredictionResult& WithInputDataLocationS3(const char* value) { SetInputDataLocationS3(value); return *this;} /** *

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

*/ inline const Aws::String& GetCreatedByIamUser() const{ return m_createdByIamUser; } /** *

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

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

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

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

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

*/ inline void SetCreatedByIamUser(const char* value) { m_createdByIamUser.assign(value); } /** *

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

*/ inline GetBatchPredictionResult& WithCreatedByIamUser(const Aws::String& value) { SetCreatedByIamUser(value); return *this;} /** *

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

*/ inline GetBatchPredictionResult& WithCreatedByIamUser(Aws::String&& value) { SetCreatedByIamUser(std::move(value)); return *this;} /** *

The AWS user account that invoked the BatchPrediction. The * account type can be either an AWS root account or an AWS Identity and Access * Management (IAM) user account.

*/ inline GetBatchPredictionResult& WithCreatedByIamUser(const char* value) { SetCreatedByIamUser(value); return *this;} /** *

The time when the BatchPrediction was created. The time is * expressed in epoch time.

*/ inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; } /** *

The time when the BatchPrediction was created. The time is * expressed in epoch time.

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

The time when the BatchPrediction was created. The time is * expressed in epoch time.

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

The time when the BatchPrediction was created. The time is * expressed in epoch time.

*/ inline GetBatchPredictionResult& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;} /** *

The time when the BatchPrediction was created. The time is * expressed in epoch time.

*/ inline GetBatchPredictionResult& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;} /** *

The time of the most recent edit to BatchPrediction. The time is * expressed in epoch time.

*/ inline const Aws::Utils::DateTime& GetLastUpdatedAt() const{ return m_lastUpdatedAt; } /** *

The time of the most recent edit to BatchPrediction. The time is * expressed in epoch time.

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

The time of the most recent edit to BatchPrediction. The time is * expressed in epoch time.

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

The time of the most recent edit to BatchPrediction. The time is * expressed in epoch time.

*/ inline GetBatchPredictionResult& WithLastUpdatedAt(const Aws::Utils::DateTime& value) { SetLastUpdatedAt(value); return *this;} /** *

The time of the most recent edit to BatchPrediction. The time is * expressed in epoch time.

*/ inline GetBatchPredictionResult& WithLastUpdatedAt(Aws::Utils::DateTime&& value) { SetLastUpdatedAt(std::move(value)); return *this;} /** *

A user-supplied name or description of the BatchPrediction.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

A user-supplied name or description of the BatchPrediction.

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

A user-supplied name or description of the BatchPrediction.

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

A user-supplied name or description of the BatchPrediction.

*/ inline void SetName(const char* value) { m_name.assign(value); } /** *

A user-supplied name or description of the BatchPrediction.

*/ inline GetBatchPredictionResult& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

A user-supplied name or description of the BatchPrediction.

*/ inline GetBatchPredictionResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

A user-supplied name or description of the BatchPrediction.

*/ inline GetBatchPredictionResult& WithName(const char* value) { SetName(value); return *this;} /** *

The status of the BatchPrediction, which can be one of the * following values:

  • PENDING - Amazon Machine * Learning (Amazon ML) submitted a request to generate batch predictions.

    *
  • INPROGRESS - The batch predictions are in * progress.

  • FAILED - The request to perform a * batch prediction did not run to completion. It is not usable.

  • * COMPLETED - The batch prediction process completed * successfully.

  • DELETED - The * BatchPrediction is marked as deleted. It is not usable.

  • *
*/ inline const EntityStatus& GetStatus() const{ return m_status; } /** *

The status of the BatchPrediction, which can be one of the * following values:

  • PENDING - Amazon Machine * Learning (Amazon ML) submitted a request to generate batch predictions.

    *
  • INPROGRESS - The batch predictions are in * progress.

  • FAILED - The request to perform a * batch prediction did not run to completion. It is not usable.

  • * COMPLETED - The batch prediction process completed * successfully.

  • DELETED - The * BatchPrediction is marked as deleted. It is not usable.

  • *
*/ inline void SetStatus(const EntityStatus& value) { m_status = value; } /** *

The status of the BatchPrediction, which can be one of the * following values:

  • PENDING - Amazon Machine * Learning (Amazon ML) submitted a request to generate batch predictions.

    *
  • INPROGRESS - The batch predictions are in * progress.

  • FAILED - The request to perform a * batch prediction did not run to completion. It is not usable.

  • * COMPLETED - The batch prediction process completed * successfully.

  • DELETED - The * BatchPrediction is marked as deleted. It is not usable.

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

The status of the BatchPrediction, which can be one of the * following values:

  • PENDING - Amazon Machine * Learning (Amazon ML) submitted a request to generate batch predictions.

    *
  • INPROGRESS - The batch predictions are in * progress.

  • FAILED - The request to perform a * batch prediction did not run to completion. It is not usable.

  • * COMPLETED - The batch prediction process completed * successfully.

  • DELETED - The * BatchPrediction is marked as deleted. It is not usable.

  • *
*/ inline GetBatchPredictionResult& WithStatus(const EntityStatus& value) { SetStatus(value); return *this;} /** *

The status of the BatchPrediction, which can be one of the * following values:

  • PENDING - Amazon Machine * Learning (Amazon ML) submitted a request to generate batch predictions.

    *
  • INPROGRESS - The batch predictions are in * progress.

  • FAILED - The request to perform a * batch prediction did not run to completion. It is not usable.

  • * COMPLETED - The batch prediction process completed * successfully.

  • DELETED - The * BatchPrediction is marked as deleted. It is not usable.

  • *
*/ inline GetBatchPredictionResult& WithStatus(EntityStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The location of an Amazon S3 bucket or directory to receive the operation * results.

*/ inline const Aws::String& GetOutputUri() const{ return m_outputUri; } /** *

The location of an Amazon S3 bucket or directory to receive the operation * results.

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

The location of an Amazon S3 bucket or directory to receive the operation * results.

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

The location of an Amazon S3 bucket or directory to receive the operation * results.

*/ inline void SetOutputUri(const char* value) { m_outputUri.assign(value); } /** *

The location of an Amazon S3 bucket or directory to receive the operation * results.

*/ inline GetBatchPredictionResult& WithOutputUri(const Aws::String& value) { SetOutputUri(value); return *this;} /** *

The location of an Amazon S3 bucket or directory to receive the operation * results.

*/ inline GetBatchPredictionResult& WithOutputUri(Aws::String&& value) { SetOutputUri(std::move(value)); return *this;} /** *

The location of an Amazon S3 bucket or directory to receive the operation * results.

*/ inline GetBatchPredictionResult& WithOutputUri(const char* value) { SetOutputUri(value); return *this;} /** *

A link to the file that contains logs of the * CreateBatchPrediction operation.

*/ inline const Aws::String& GetLogUri() const{ return m_logUri; } /** *

A link to the file that contains logs of the * CreateBatchPrediction operation.

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

A link to the file that contains logs of the * CreateBatchPrediction operation.

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

A link to the file that contains logs of the * CreateBatchPrediction operation.

*/ inline void SetLogUri(const char* value) { m_logUri.assign(value); } /** *

A link to the file that contains logs of the * CreateBatchPrediction operation.

*/ inline GetBatchPredictionResult& WithLogUri(const Aws::String& value) { SetLogUri(value); return *this;} /** *

A link to the file that contains logs of the * CreateBatchPrediction operation.

*/ inline GetBatchPredictionResult& WithLogUri(Aws::String&& value) { SetLogUri(std::move(value)); return *this;} /** *

A link to the file that contains logs of the * CreateBatchPrediction operation.

*/ inline GetBatchPredictionResult& WithLogUri(const char* value) { SetLogUri(value); return *this;} /** *

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

A description of the most recent details about processing the batch * prediction request.

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

The approximate CPU time in milliseconds that Amazon Machine Learning spent * processing the BatchPrediction, normalized and scaled on * computation resources. ComputeTime is only available if the * BatchPrediction is in the COMPLETED state.

*/ inline long long GetComputeTime() const{ return m_computeTime; } /** *

The approximate CPU time in milliseconds that Amazon Machine Learning spent * processing the BatchPrediction, normalized and scaled on * computation resources. ComputeTime is only available if the * BatchPrediction is in the COMPLETED state.

*/ inline void SetComputeTime(long long value) { m_computeTime = value; } /** *

The approximate CPU time in milliseconds that Amazon Machine Learning spent * processing the BatchPrediction, normalized and scaled on * computation resources. ComputeTime is only available if the * BatchPrediction is in the COMPLETED state.

*/ inline GetBatchPredictionResult& WithComputeTime(long long value) { SetComputeTime(value); return *this;} /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as COMPLETED or FAILED. * FinishedAt is only available when the BatchPrediction * is in the COMPLETED or FAILED state.

*/ inline const Aws::Utils::DateTime& GetFinishedAt() const{ return m_finishedAt; } /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as COMPLETED or FAILED. * FinishedAt is only available when the BatchPrediction * is in the COMPLETED or FAILED state.

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

The epoch time when Amazon Machine Learning marked the * BatchPrediction as COMPLETED or FAILED. * FinishedAt is only available when the BatchPrediction * is in the COMPLETED or FAILED state.

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

The epoch time when Amazon Machine Learning marked the * BatchPrediction as COMPLETED or FAILED. * FinishedAt is only available when the BatchPrediction * is in the COMPLETED or FAILED state.

*/ inline GetBatchPredictionResult& WithFinishedAt(const Aws::Utils::DateTime& value) { SetFinishedAt(value); return *this;} /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as COMPLETED or FAILED. * FinishedAt is only available when the BatchPrediction * is in the COMPLETED or FAILED state.

*/ inline GetBatchPredictionResult& WithFinishedAt(Aws::Utils::DateTime&& value) { SetFinishedAt(std::move(value)); return *this;} /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as INPROGRESS. StartedAt * isn't available if the BatchPrediction is in the * PENDING state.

*/ inline const Aws::Utils::DateTime& GetStartedAt() const{ return m_startedAt; } /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as INPROGRESS. StartedAt * isn't available if the BatchPrediction is in the * PENDING state.

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

The epoch time when Amazon Machine Learning marked the * BatchPrediction as INPROGRESS. StartedAt * isn't available if the BatchPrediction is in the * PENDING state.

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

The epoch time when Amazon Machine Learning marked the * BatchPrediction as INPROGRESS. StartedAt * isn't available if the BatchPrediction is in the * PENDING state.

*/ inline GetBatchPredictionResult& WithStartedAt(const Aws::Utils::DateTime& value) { SetStartedAt(value); return *this;} /** *

The epoch time when Amazon Machine Learning marked the * BatchPrediction as INPROGRESS. StartedAt * isn't available if the BatchPrediction is in the * PENDING state.

*/ inline GetBatchPredictionResult& WithStartedAt(Aws::Utils::DateTime&& value) { SetStartedAt(std::move(value)); return *this;} /** *

The number of total records that Amazon Machine Learning saw while processing * the BatchPrediction.

*/ inline long long GetTotalRecordCount() const{ return m_totalRecordCount; } /** *

The number of total records that Amazon Machine Learning saw while processing * the BatchPrediction.

*/ inline void SetTotalRecordCount(long long value) { m_totalRecordCount = value; } /** *

The number of total records that Amazon Machine Learning saw while processing * the BatchPrediction.

*/ inline GetBatchPredictionResult& WithTotalRecordCount(long long value) { SetTotalRecordCount(value); return *this;} /** *

The number of invalid records that Amazon Machine Learning saw while * processing the BatchPrediction.

*/ inline long long GetInvalidRecordCount() const{ return m_invalidRecordCount; } /** *

The number of invalid records that Amazon Machine Learning saw while * processing the BatchPrediction.

*/ inline void SetInvalidRecordCount(long long value) { m_invalidRecordCount = value; } /** *

The number of invalid records that Amazon Machine Learning saw while * processing the BatchPrediction.

*/ inline GetBatchPredictionResult& WithInvalidRecordCount(long long value) { SetInvalidRecordCount(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 GetBatchPredictionResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline GetBatchPredictionResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline GetBatchPredictionResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_batchPredictionId; Aws::String m_mLModelId; Aws::String m_batchPredictionDataSourceId; Aws::String m_inputDataLocationS3; Aws::String m_createdByIamUser; Aws::Utils::DateTime m_createdAt; Aws::Utils::DateTime m_lastUpdatedAt; Aws::String m_name; EntityStatus m_status; Aws::String m_outputUri; Aws::String m_logUri; Aws::String m_message; long long m_computeTime; Aws::Utils::DateTime m_finishedAt; Aws::Utils::DateTime m_startedAt; long long m_totalRecordCount; long long m_invalidRecordCount; Aws::String m_requestId; }; } // namespace Model } // namespace MachineLearning } // namespace Aws