CreateBatchPredictionRequest (AWS SDK For Java for OSGi 1.10.12 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.machinelearning.model.CreateBatchPredictionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateBatchPredictionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the CreateBatchPrediction operation.
Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource . This operation creates a new BatchPrediction , and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction , Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING . After the BatchPrediction completes, Amazon ML sets the status to COMPLETED .

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

See Also:
AmazonMachineLearning.createBatchPrediction(CreateBatchPredictionRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateBatchPredictionRequest()

Constructors
Constructor and Description
`CreateBatchPredictionRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateBatchPredictionRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getBatchPredictionDataSourceId()` The ID of the `DataSource` that points to the group of observations to predict.
`String`	`getBatchPredictionId()` A user-supplied ID that uniquely identifies the `BatchPrediction`.
`String`	`getBatchPredictionName()` A user-supplied name or description of the `BatchPrediction`.
`String`	`getMLModelId()` The ID of the `MLModel` that will generate predictions for the group of observations.
`String`	`getOutputUri()` The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results.
`int`	`hashCode()`
`void`	`setBatchPredictionDataSourceId(String batchPredictionDataSourceId)` The ID of the `DataSource` that points to the group of observations to predict.
`void`	`setBatchPredictionId(String batchPredictionId)` A user-supplied ID that uniquely identifies the `BatchPrediction`.
`void`	`setBatchPredictionName(String batchPredictionName)` A user-supplied name or description of the `BatchPrediction`.
`void`	`setMLModelId(String mLModelId)` The ID of the `MLModel` that will generate predictions for the group of observations.
`void`	`setOutputUri(String outputUri)` The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateBatchPredictionRequest`	`withBatchPredictionDataSourceId(String batchPredictionDataSourceId)` The ID of the `DataSource` that points to the group of observations to predict.
`CreateBatchPredictionRequest`	`withBatchPredictionId(String batchPredictionId)` A user-supplied ID that uniquely identifies the `BatchPrediction`.
`CreateBatchPredictionRequest`	`withBatchPredictionName(String batchPredictionName)` A user-supplied name or description of the `BatchPrediction`.
`CreateBatchPredictionRequest`	`withMLModelId(String mLModelId)` The ID of the `MLModel` that will generate predictions for the group of observations.
`CreateBatchPredictionRequest`	`withOutputUri(String outputUri)` The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateBatchPredictionRequest
```
public CreateBatchPredictionRequest()
```
- Method Detail
  - getBatchPredictionId
```
public String getBatchPredictionId()
```
    A user-supplied ID that uniquely identifies the BatchPrediction.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    A user-supplied ID that uniquely identifies the BatchPrediction.
  - setBatchPredictionId
```
public void setBatchPredictionId(String batchPredictionId)
```
    A user-supplied ID that uniquely identifies the BatchPrediction.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    batchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction.
  - withBatchPredictionId
```
public CreateBatchPredictionRequest withBatchPredictionId(String batchPredictionId)
```
    A user-supplied ID that uniquely identifies the BatchPrediction.
    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 - A user-supplied ID that uniquely identifies the BatchPrediction.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getBatchPredictionName
```
public String getBatchPredictionName()
```
    A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Returns:
    A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
  - setBatchPredictionName
```
public void setBatchPredictionName(String batchPredictionName)
```
    A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    batchPredictionName - A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
  - withBatchPredictionName
```
public CreateBatchPredictionRequest withBatchPredictionName(String batchPredictionName)
```
    A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    batchPredictionName - A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
    
    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 will generate predictions for the group of observations.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID of the MLModel that will generate predictions for the group of observations.
  - setMLModelId
```
public void setMLModelId(String mLModelId)
```
    The ID of the MLModel that will generate predictions for the group of observations.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    mLModelId - The ID of the MLModel that will generate predictions for the group of observations.
  - withMLModelId
```
public CreateBatchPredictionRequest withMLModelId(String mLModelId)
```
    The ID of the MLModel that will generate predictions for the group of observations.
    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 will generate predictions for the group of observations.
    
    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 CreateBatchPredictionRequest 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.
  - getOutputUri
```
public String getOutputUri()
```
    The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    Returns:
    The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
  - setOutputUri
```
public void setOutputUri(String outputUri)
```
    The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
    Constraints:
    Length: 0 - 2048
    Pattern: s3://([^/]+)(/.*)?
    
    Parameters:
    outputUri - The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
  - withOutputUri
```
public CreateBatchPredictionRequest withOutputUri(String outputUri)
```
    The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
    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 Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
    Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
    
    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 CreateBatchPredictionRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Class CreateBatchPredictionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateBatchPredictionRequest

Method Detail

getBatchPredictionId

setBatchPredictionId

withBatchPredictionId

getBatchPredictionName

setBatchPredictionName

withBatchPredictionName

getMLModelId

setMLModelId

withMLModelId

getBatchPredictionDataSourceId

setBatchPredictionDataSourceId

withBatchPredictionDataSourceId

getOutputUri

setOutputUri

withOutputUri

toString

hashCode

equals

clone