Class BatchPrediction
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the output of GetBatchPrediction operation.
The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The ID of theDataSource
that points to the group of observations to predict.The ID assigned to theBatchPrediction
at creation.The time that theBatchPrediction
was created.The AWS user account that invoked theBatchPrediction
.The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).The time of the most recent edit to theBatchPrediction
.A description of the most recent details about processing the batch prediction request.The ID of theMLModel
that generated predictions for theBatchPrediction
request.getName()
A user-supplied name or description of theBatchPrediction
.The location of an Amazon S3 bucket or directory to receive the operation results.The status of theBatchPrediction
.int
hashCode()
void
setBatchPredictionDataSourceId
(String batchPredictionDataSourceId) The ID of theDataSource
that points to the group of observations to predict.void
setBatchPredictionId
(String batchPredictionId) The ID assigned to theBatchPrediction
at creation.void
setCreatedAt
(Date createdAt) The time that theBatchPrediction
was created.void
setCreatedByIamUser
(String createdByIamUser) The AWS user account that invoked theBatchPrediction
.void
setInputDataLocationS3
(String inputDataLocationS3) The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).void
setLastUpdatedAt
(Date lastUpdatedAt) The time of the most recent edit to theBatchPrediction
.void
setMessage
(String message) A description of the most recent details about processing the batch prediction request.void
setMLModelId
(String mLModelId) The ID of theMLModel
that generated predictions for theBatchPrediction
request.void
A user-supplied name or description of theBatchPrediction
.void
setOutputUri
(String outputUri) The location of an Amazon S3 bucket or directory to receive the operation results.void
setStatus
(EntityStatus status) The status of theBatchPrediction
.void
The status of theBatchPrediction
.toString()
Returns a string representation of this object; useful for testing and debugging.withBatchPredictionDataSourceId
(String batchPredictionDataSourceId) The ID of theDataSource
that points to the group of observations to predict.withBatchPredictionId
(String batchPredictionId) The ID assigned to theBatchPrediction
at creation.withCreatedAt
(Date createdAt) The time that theBatchPrediction
was created.withCreatedByIamUser
(String createdByIamUser) The AWS user account that invoked theBatchPrediction
.withInputDataLocationS3
(String inputDataLocationS3) The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).withLastUpdatedAt
(Date lastUpdatedAt) The time of the most recent edit to theBatchPrediction
.withMessage
(String message) A description of the most recent details about processing the batch prediction request.withMLModelId
(String mLModelId) The ID of theMLModel
that generated predictions for theBatchPrediction
request.A user-supplied name or description of theBatchPrediction
.withOutputUri
(String outputUri) The location of an Amazon S3 bucket or directory to receive the operation results.withStatus
(EntityStatus status) The status of theBatchPrediction
.withStatus
(String status) The status of theBatchPrediction
.
-
Constructor Details
-
BatchPrediction
public BatchPrediction()
-
-
Method Details
-
setBatchPredictionId
The ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Parameters:
batchPredictionId
- The ID assigned to theBatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.
-
getBatchPredictionId
The ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Returns:
- The ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.
-
withBatchPredictionId
The ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Parameters:
batchPredictionId
- The ID assigned to theBatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMLModelId
The ID of the
MLModel
that generated predictions for theBatchPrediction
request.- Parameters:
mLModelId
- The ID of theMLModel
that generated predictions for theBatchPrediction
request.
-
getMLModelId
The ID of the
MLModel
that generated predictions for theBatchPrediction
request.- Returns:
- The ID of the
MLModel
that generated predictions for theBatchPrediction
request.
-
withMLModelId
The ID of the
MLModel
that generated predictions for theBatchPrediction
request.- Parameters:
mLModelId
- The ID of theMLModel
that generated predictions for theBatchPrediction
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBatchPredictionDataSourceId
The ID of the
DataSource
that points to the group of observations to predict.- Parameters:
batchPredictionDataSourceId
- The ID of theDataSource
that points to the group of observations to predict.
-
getBatchPredictionDataSourceId
The ID of the
DataSource
that points to the group of observations to predict.- Returns:
- The ID of the
DataSource
that points to the group of observations to predict.
-
withBatchPredictionDataSourceId
The ID of the
DataSource
that points to the group of observations to predict.- Parameters:
batchPredictionDataSourceId
- The ID of theDataSource
that points to the group of observations to predict.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
- Parameters:
inputDataLocationS3
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
-
getInputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
- Returns:
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
-
withInputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
- Parameters:
inputDataLocationS3
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedByIamUser
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.- Parameters:
createdByIamUser
- The AWS user account that invoked theBatchPrediction
. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
-
getCreatedByIamUser
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.- Returns:
- 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.
-
withCreatedByIamUser
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.- Parameters:
createdByIamUser
- The AWS user account that invoked theBatchPrediction
. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
The time that the
BatchPrediction
was created. The time is expressed in epoch time.- Parameters:
createdAt
- The time that theBatchPrediction
was created. The time is expressed in epoch time.
-
getCreatedAt
The time that the
BatchPrediction
was created. The time is expressed in epoch time.- Returns:
- The time that the
BatchPrediction
was created. The time is expressed in epoch time.
-
withCreatedAt
The time that the
BatchPrediction
was created. The time is expressed in epoch time.- Parameters:
createdAt
- The time that theBatchPrediction
was created. The time is expressed in epoch time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLastUpdatedAt
The time of the most recent edit to the
BatchPrediction
. The time is expressed in epoch time.- Parameters:
lastUpdatedAt
- The time of the most recent edit to theBatchPrediction
. The time is expressed in epoch time.
-
getLastUpdatedAt
The time of the most recent edit to the
BatchPrediction
. The time is expressed in epoch time.- Returns:
- The time of the most recent edit to the
BatchPrediction
. The time is expressed in epoch time.
-
withLastUpdatedAt
The time of the most recent edit to the
BatchPrediction
. The time is expressed in epoch time.- Parameters:
lastUpdatedAt
- The time of the most recent edit to theBatchPrediction
. The time is expressed in epoch time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
A user-supplied name or description of the
BatchPrediction
.- Parameters:
name
- A user-supplied name or description of theBatchPrediction
.
-
getName
A user-supplied name or description of the
BatchPrediction
.- Returns:
- A user-supplied name or description of the
BatchPrediction
.
-
withName
A user-supplied name or description of the
BatchPrediction
.- Parameters:
name
- A user-supplied name or description of theBatchPrediction
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
-
-
getStatus
The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
- Returns:
- The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
-
-
withStatus
The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setStatus
The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
-
-
withStatus
The status of the
BatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
. This element can have one of the following values:-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. -
INPROGRESS
- The process is underway. -
FAILED
- The request to peform a batch prediction did not run to completion. It is not usable. -
COMPLETED
- The batch prediction process completed successfully. -
DELETED
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setOutputUri
The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
- Parameters:
outputUri
- The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
-
getOutputUri
The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
- Returns:
- The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
-
withOutputUri
The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
- Parameters:
outputUri
- The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMessage
A description of the most recent details about processing the batch prediction request.
- Parameters:
message
- A description of the most recent details about processing the batch prediction request.
-
getMessage
A description of the most recent details about processing the batch prediction request.
- Returns:
- A description of the most recent details about processing the batch prediction request.
-
withMessage
A description of the most recent details about processing the batch prediction request.
- Parameters:
message
- A description of the most recent details about processing the batch prediction request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-