Class GetBatchPredictionResult
- java.lang.Object
-
- com.amazonaws.services.machinelearning.model.GetBatchPredictionResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class GetBatchPredictionResult extends Object implements Serializable, Cloneable
Represents the output of a GetBatchPrediction operation and describes a
BatchPrediction
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description GetBatchPredictionResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetBatchPredictionResult
clone()
boolean
equals(Object obj)
String
getBatchPredictionDataSourceId()
The ID of theDataSource
that was used to create theBatchPrediction
.String
getBatchPredictionId()
An ID assigned to theBatchPrediction
at creation.Date
getCreatedAt()
The time when 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 toBatchPrediction
.String
getLogUri()
A link to the file that contains logs of the CreateBatchPrediction operation.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
, which can be one of the following values:int
hashCode()
void
setBatchPredictionDataSourceId(String batchPredictionDataSourceId)
The ID of theDataSource
that was used to create theBatchPrediction
.void
setBatchPredictionId(String batchPredictionId)
An ID assigned to theBatchPrediction
at creation.void
setCreatedAt(Date createdAt)
The time when 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 toBatchPrediction
.void
setLogUri(String logUri)
A link to the file that contains logs of the CreateBatchPrediction operation.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
, which can be one of the following values:void
setStatus(String status)
The status of theBatchPrediction
, which can be one of the following values:String
toString()
Returns a string representation of this object; useful for testing and debugging.GetBatchPredictionResult
withBatchPredictionDataSourceId(String batchPredictionDataSourceId)
The ID of theDataSource
that was used to create theBatchPrediction
.GetBatchPredictionResult
withBatchPredictionId(String batchPredictionId)
An ID assigned to theBatchPrediction
at creation.GetBatchPredictionResult
withCreatedAt(Date createdAt)
The time when theBatchPrediction
was created.GetBatchPredictionResult
withCreatedByIamUser(String createdByIamUser)
The AWS user account that invoked theBatchPrediction
.GetBatchPredictionResult
withInputDataLocationS3(String inputDataLocationS3)
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).GetBatchPredictionResult
withLastUpdatedAt(Date lastUpdatedAt)
The time of the most recent edit toBatchPrediction
.GetBatchPredictionResult
withLogUri(String logUri)
A link to the file that contains logs of the CreateBatchPrediction operation.GetBatchPredictionResult
withMessage(String message)
A description of the most recent details about processing the batch prediction request.GetBatchPredictionResult
withMLModelId(String mLModelId)
The ID of theMLModel
that generated predictions for theBatchPrediction
request.GetBatchPredictionResult
withName(String name)
A user-supplied name or description of theBatchPrediction
.GetBatchPredictionResult
withOutputUri(String outputUri)
The location of an Amazon S3 bucket or directory to receive the operation results.GetBatchPredictionResult
withStatus(EntityStatus status)
The status of theBatchPrediction
, which can be one of the following values:GetBatchPredictionResult
withStatus(String status)
The status of theBatchPrediction
, which can be one of the following values:
-
-
-
Method Detail
-
setBatchPredictionId
public void setBatchPredictionId(String batchPredictionId)
An ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Parameters:
batchPredictionId
- An ID assigned to theBatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.
-
getBatchPredictionId
public String getBatchPredictionId()
An ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Returns:
- An ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.
-
withBatchPredictionId
public GetBatchPredictionResult withBatchPredictionId(String batchPredictionId)
An ID assigned to the
BatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.- Parameters:
batchPredictionId
- An 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 GetBatchPredictionResult 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 was used to create theBatchPrediction
.- Parameters:
batchPredictionDataSourceId
- The ID of theDataSource
that was used to create theBatchPrediction
.
-
getBatchPredictionDataSourceId
public String getBatchPredictionDataSourceId()
The ID of the
DataSource
that was used to create theBatchPrediction
.- Returns:
- The ID of the
DataSource
that was used to create theBatchPrediction
.
-
withBatchPredictionDataSourceId
public GetBatchPredictionResult withBatchPredictionDataSourceId(String batchPredictionDataSourceId)
The ID of the
DataSource
that was used to create theBatchPrediction
.- Parameters:
batchPredictionDataSourceId
- The ID of theDataSource
that was used to create theBatchPrediction
.- 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 GetBatchPredictionResult 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 GetBatchPredictionResult 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 when the
BatchPrediction
was created. The time is expressed in epoch time.- Parameters:
createdAt
- The time when theBatchPrediction
was created. The time is expressed in epoch time.
-
getCreatedAt
public Date getCreatedAt()
The time when the
BatchPrediction
was created. The time is expressed in epoch time.- Returns:
- The time when the
BatchPrediction
was created. The time is expressed in epoch time.
-
withCreatedAt
public GetBatchPredictionResult withCreatedAt(Date createdAt)
The time when the
BatchPrediction
was created. The time is expressed in epoch time.- Parameters:
createdAt
- The time when 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
BatchPrediction
. The time is expressed in epoch time.- Parameters:
lastUpdatedAt
- The time of the most recent edit toBatchPrediction
. The time is expressed in epoch time.
-
getLastUpdatedAt
public Date getLastUpdatedAt()
The time of the most recent edit to
BatchPrediction
. The time is expressed in epoch time.- Returns:
- The time of the most recent edit to
BatchPrediction
. The time is expressed in epoch time.
-
withLastUpdatedAt
public GetBatchPredictionResult withLastUpdatedAt(Date lastUpdatedAt)
The time of the most recent edit to
BatchPrediction
. The time is expressed in epoch time.- Parameters:
lastUpdatedAt
- The time of the most recent edit toBatchPrediction
. 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 GetBatchPredictionResult 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
, 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
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
, 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
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
EntityStatus
-
-
getStatus
public String getStatus()
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
- TheBatchPrediction
is marked as deleted. It is not usable.
- Returns:
- 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
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
EntityStatus
-
-
withStatus
public GetBatchPredictionResult withStatus(String 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
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
, 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
- 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
, 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
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
, 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
- TheBatchPrediction
is marked as deleted. It is not usable.
-
- See Also:
EntityStatus
-
-
withStatus
public GetBatchPredictionResult withStatus(EntityStatus 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
- TheBatchPrediction
is marked as deleted. It is not usable.
- Parameters:
status
- The status of theBatchPrediction
, 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
- 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.
- Parameters:
outputUri
- The location of an Amazon S3 bucket or directory to receive the operation results.
-
getOutputUri
public String getOutputUri()
The location of an Amazon S3 bucket or directory to receive the operation results.
- Returns:
- The location of an Amazon S3 bucket or directory to receive the operation results.
-
withOutputUri
public GetBatchPredictionResult withOutputUri(String outputUri)
The location of an Amazon S3 bucket or directory to receive the operation results.
- Parameters:
outputUri
- The location of an Amazon S3 bucket or directory to receive the operation results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLogUri
public void setLogUri(String logUri)
A link to the file that contains logs of the CreateBatchPrediction operation.
- Parameters:
logUri
- A link to the file that contains logs of the CreateBatchPrediction operation.
-
getLogUri
public String getLogUri()
A link to the file that contains logs of the CreateBatchPrediction operation.
- Returns:
- A link to the file that contains logs of the CreateBatchPrediction operation.
-
withLogUri
public GetBatchPredictionResult withLogUri(String logUri)
A link to the file that contains logs of the CreateBatchPrediction operation.
- Parameters:
logUri
- A link to the file that contains logs of the CreateBatchPrediction operation.- 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 GetBatchPredictionResult 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 GetBatchPredictionResult clone()
-
-