Class BatchPrediction
- java.lang.Object
-
- com.amazonaws.services.machinelearning.model.BatchPrediction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class BatchPrediction extends Object implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BatchPrediction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchPrediction
clone()
boolean
equals(Object obj)
String
getBatchPredictionDataSourceId()
The ID of theDataSource
that points to the group of observations to predict.String
getBatchPredictionId()
The ID assigned to theBatchPrediction
at creation.Date
getCreatedAt()
The time that theBatchPrediction
was created.String
getCreatedByIamUser()
The AWS user account that invoked theBatchPrediction
.String
getInputDataLocationS3()
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).Date
getLastUpdatedAt()
The time of the most recent edit to theBatchPrediction
.String
getMessage()
A description of the most recent details about processing the batch prediction request.String
getMLModelId()
The ID of theMLModel
that generated predictions for theBatchPrediction
request.String
getName()
A user-supplied name or description of theBatchPrediction
.String
getOutputUri()
The location of an Amazon S3 bucket or directory to receive the operation results.String
getStatus()
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
setName(String name)
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
setStatus(String status)
The status of theBatchPrediction
.String
toString()
Returns a string representation of this object; useful for testing and debugging.BatchPrediction
withBatchPredictionDataSourceId(String batchPredictionDataSourceId)
The ID of theDataSource
that points to the group of observations to predict.BatchPrediction
withBatchPredictionId(String batchPredictionId)
The ID assigned to theBatchPrediction
at creation.BatchPrediction
withCreatedAt(Date createdAt)
The time that theBatchPrediction
was created.BatchPrediction
withCreatedByIamUser(String createdByIamUser)
The AWS user account that invoked theBatchPrediction
.BatchPrediction
withInputDataLocationS3(String inputDataLocationS3)
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).BatchPrediction
withLastUpdatedAt(Date lastUpdatedAt)
The time of the most recent edit to theBatchPrediction
.BatchPrediction
withMessage(String message)
A description of the most recent details about processing the batch prediction request.BatchPrediction
withMLModelId(String mLModelId)
The ID of theMLModel
that generated predictions for theBatchPrediction
request.BatchPrediction
withName(String name)
A user-supplied name or description of theBatchPrediction
.BatchPrediction
withOutputUri(String outputUri)
The location of an Amazon S3 bucket or directory to receive the operation results.BatchPrediction
withStatus(EntityStatus status)
The status of theBatchPrediction
.BatchPrediction
withStatus(String status)
The status of theBatchPrediction
.
-
-
-
Method Detail
-
setBatchPredictionId
public void setBatchPredictionId(String batchPredictionId)
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
public String 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
public BatchPrediction withBatchPredictionId(String batchPredictionId)
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
public void setMLModelId(String mLModelId)
The ID of the
MLModel
that generated predictions for theBatchPrediction
request.- Parameters:
mLModelId
- The ID of theMLModel
that generated predictions for theBatchPrediction
request.
-
getMLModelId
public String 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
public BatchPrediction withMLModelId(String mLModelId)
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
public void setBatchPredictionDataSourceId(String batchPredictionDataSourceId)
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
public String 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
public BatchPrediction withBatchPredictionDataSourceId(String batchPredictionDataSourceId)
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
public void setInputDataLocationS3(String inputDataLocationS3)
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
public String 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
public BatchPrediction withInputDataLocationS3(String inputDataLocationS3)
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
public void setCreatedByIamUser(String 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.- 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
public String 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
public BatchPrediction withCreatedByIamUser(String 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.- 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
public void setCreatedAt(Date createdAt)
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
public Date 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
public BatchPrediction withCreatedAt(Date createdAt)
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
public void setLastUpdatedAt(Date lastUpdatedAt)
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
public Date 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
public BatchPrediction withLastUpdatedAt(Date lastUpdatedAt)
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
public void setName(String name)
A user-supplied name or description of the
BatchPrediction
.- Parameters:
name
- A user-supplied name or description of theBatchPrediction
.
-
getName
public String getName()
A user-supplied name or description of the
BatchPrediction
.- Returns:
- A user-supplied name or description of the
BatchPrediction
.
-
withName
public BatchPrediction withName(String name)
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
public void setStatus(String status)
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:
EntityStatus
-
-
getStatus
public String 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:
EntityStatus
-
-
withStatus
public BatchPrediction withStatus(String status)
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:
EntityStatus
-
-
setStatus
public void setStatus(EntityStatus status)
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:
EntityStatus
-
-
withStatus
public BatchPrediction withStatus(EntityStatus status)
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:
EntityStatus
-
-
setOutputUri
public void setOutputUri(String 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: ':', '//', '/./', '/../'.
- 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
public String 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
public BatchPrediction withOutputUri(String 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: ':', '//', '/./', '/../'.
- 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
public void setMessage(String message)
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
public String 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
public BatchPrediction withMessage(String message)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public BatchPrediction clone()
-
-