BatchPrediction (AWS SDK For Java for OSGi 1.10.1 API)

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 and Description

BatchPrediction()

Constructors
Constructor and Description
`BatchPrediction()`

Method Summary

Methods
Modifier and Type	Method and Description
`BatchPrediction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBatchPredictionDataSourceId()` The ID of the `DataSource` that points to the group of observations to predict.
`String`	`getBatchPredictionId()` The ID assigned to the `BatchPrediction` at creation.
`Date`	`getCreatedAt()` The time that the `BatchPrediction` was created.
`String`	`getCreatedByIamUser()` The AWS user account that invoked the `BatchPrediction`.
`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 the `BatchPrediction`.
`String`	`getMessage()` A description of the most recent details about processing the batch prediction request.
`String`	`getMLModelId()` The ID of the `MLModel` that generated predictions for the `BatchPrediction` request.
`String`	`getName()` A user-supplied name or description of the `BatchPrediction`.
`String`	`getOutputUri()` The location of an Amazon S3 bucket or directory to receive the operation results.
`String`	`getStatus()` The status of the `BatchPrediction`.
`int`	`hashCode()`
`void`	`setBatchPredictionDataSourceId(String batchPredictionDataSourceId)` The ID of the `DataSource` that points to the group of observations to predict.
`void`	`setBatchPredictionId(String batchPredictionId)` The ID assigned to the `BatchPrediction` at creation.
`void`	`setCreatedAt(Date createdAt)` The time that the `BatchPrediction` was created.
`void`	`setCreatedByIamUser(String createdByIamUser)` The AWS user account that invoked the `BatchPrediction`.
`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 the `BatchPrediction`.
`void`	`setMessage(String message)` A description of the most recent details about processing the batch prediction request.
`void`	`setMLModelId(String mLModelId)` The ID of the `MLModel` that generated predictions for the `BatchPrediction` request.
`void`	`setName(String name)` A user-supplied name or description of the `BatchPrediction`.
`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 the `BatchPrediction`.
`void`	`setStatus(String status)` The status of the `BatchPrediction`.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BatchPrediction`	`withBatchPredictionDataSourceId(String batchPredictionDataSourceId)` The ID of the `DataSource` that points to the group of observations to predict.
`BatchPrediction`	`withBatchPredictionId(String batchPredictionId)` The ID assigned to the `BatchPrediction` at creation.
`BatchPrediction`	`withCreatedAt(Date createdAt)` The time that the `BatchPrediction` was created.
`BatchPrediction`	`withCreatedByIamUser(String createdByIamUser)` The AWS user account that invoked the `BatchPrediction`.
`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 the `BatchPrediction`.
`BatchPrediction`	`withMessage(String message)` A description of the most recent details about processing the batch prediction request.
`BatchPrediction`	`withMLModelId(String mLModelId)` The ID of the `MLModel` that generated predictions for the `BatchPrediction` request.
`BatchPrediction`	`withName(String name)` A user-supplied name or description of the `BatchPrediction`.
`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 the `BatchPrediction`.
`BatchPrediction`	`withStatus(String status)` The status of the `BatchPrediction`.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchPrediction
```
public BatchPrediction()
```
- Method Detail
  - getBatchPredictionId
```
public String getBatchPredictionId()
```
    The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
  - setBatchPredictionId
```
public void setBatchPredictionId(String batchPredictionId)
```
    The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    batchPredictionId - The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID 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 the BatchPredictionID in the request.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    batchPredictionId - The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMLModelId
```
public String getMLModelId()
```
    The ID of the MLModel that generated predictions for the BatchPrediction request.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID of the MLModel that generated predictions for the BatchPrediction request.
  - setMLModelId
```
public void setMLModelId(String mLModelId)
```
    The ID of the MLModel that generated predictions for the BatchPrediction request.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    mLModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.
  - withMLModelId
```
public BatchPrediction withMLModelId(String mLModelId)
```
    The ID of the MLModel that generated predictions for the BatchPrediction request.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    mLModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getBatchPredictionDataSourceId
```
public String getBatchPredictionDataSourceId()
```
    The ID of the DataSource that points to the group of observations to predict.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID of the DataSource that points to the group of observations to predict.
  - setBatchPredictionDataSourceId
```
public void setBatchPredictionDataSourceId(String batchPredictionDataSourceId)
```
    The ID of the DataSource that points to the group of observations to predict.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    batchPredictionDataSourceId - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInputDataLocationS3
```
public String getInputDataLocationS3()
```
    The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    Returns:
    The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
  - setInputDataLocationS3
```
public void setInputDataLocationS3(String inputDataLocationS3)
```
    The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    Parameters:
    inputDataLocationS3 - 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).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    Parameters:
    inputDataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
    
    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.
  - 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.
    Constraints:
    Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
    
    Parameters:
    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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    createdAt - The time that the BatchPrediction was created. The time is expressed in epoch time.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    lastUpdatedAt - The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public String getName()
```
    A user-supplied name or description of the BatchPrediction.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Returns:
    A user-supplied name or description of the BatchPrediction.
  - setName
```
public void setName(String name)
```
    A user-supplied name or description of the BatchPrediction.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    name - A user-supplied name or description of the BatchPrediction.
  - withName
```
public BatchPrediction withName(String name)
```
    A user-supplied name or description of the BatchPrediction.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    name - A user-supplied name or description of the BatchPrediction.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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 - The BatchPrediction is marked as deleted. It is not usable.
    Constraints:
    Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
    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 - The BatchPrediction is marked as deleted. It is not usable.
    See Also:
    EntityStatus
  - 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 - The BatchPrediction is marked as deleted. It is not usable.
    Constraints:
    Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
    Parameters:
    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 - The BatchPrediction 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 - The BatchPrediction is marked as deleted. It is not usable.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
    Parameters:
    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 - The BatchPrediction is marked as deleted. It is not usable.
    Returns:
    A reference to this updated 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 - The BatchPrediction is marked as deleted. It is not usable.
    Constraints:
    Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
    Parameters:
    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 - The BatchPrediction 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 - The BatchPrediction is marked as deleted. It is not usable.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
    Parameters:
    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 - The BatchPrediction is marked as deleted. It is not usable.
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    EntityStatus
  - 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: ':', '//', '/./', '/../'.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    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: ':', '//', '/./', '/../'.
  - 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: ':', '//', '/./', '/../'.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    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: ':', '//', '/./', '/../'.
  - 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: ':', '//', '/./', '/../'.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getMessage
```
public String getMessage()
```
    A description of the most recent details about processing the batch prediction request.
    Constraints:
    Length: 0 - 10240
    
    Returns:
    A description of the most recent details about processing the batch prediction request.
  - setMessage
```
public void setMessage(String message)
```
    A description of the most recent details about processing the batch prediction request.
    Constraints:
    Length: 0 - 10240
    
    Parameters:
    message - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 10240
    
    Parameters:
    message - A description of the most recent details about processing the batch prediction request.
    
    Returns:
    A reference to this updated 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 class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public BatchPrediction clone()
```
    Overrides:
    
    clone in class Object

Class BatchPrediction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchPrediction

Method Detail

getBatchPredictionId

setBatchPredictionId

withBatchPredictionId

getMLModelId

setMLModelId

withMLModelId

getBatchPredictionDataSourceId

setBatchPredictionDataSourceId

withBatchPredictionDataSourceId

getInputDataLocationS3

setInputDataLocationS3

withInputDataLocationS3

getCreatedByIamUser

setCreatedByIamUser

withCreatedByIamUser

getCreatedAt

setCreatedAt

withCreatedAt

getLastUpdatedAt

setLastUpdatedAt

withLastUpdatedAt

getName

setName

withName

getStatus

setStatus

withStatus

setStatus

withStatus

getOutputUri

setOutputUri

withOutputUri

getMessage

setMessage

withMessage

toString

hashCode

equals

clone