BatchPrediction (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.machinelearning.model.BatchPrediction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchPrediction.Builder,BatchPrediction>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class BatchPrediction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchPrediction.Builder,BatchPrediction>
```
Represents the output of a GetBatchPrediction operation.

The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BatchPrediction.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BatchPrediction.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`batchPredictionDataSourceId()` The ID of the `DataSource` that points to the group of observations to predict.
`String`	`batchPredictionId()` The ID assigned to the `BatchPrediction` at creation.
`static BatchPrediction.Builder`	`builder()`
`Long`	`computeTime()` Returns the value of the ComputeTime property for this object.
`Instant`	`createdAt()` The time that the `BatchPrediction` was created.
`String`	`createdByIamUser()` The AWS user account that invoked the `BatchPrediction`.
`boolean`	`equals(Object obj)`
`Instant`	`finishedAt()` Returns the value of the FinishedAt property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`inputDataLocationS3()` The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
`Long`	`invalidRecordCount()` Returns the value of the InvalidRecordCount property for this object.
`Instant`	`lastUpdatedAt()` The time of the most recent edit to the `BatchPrediction`.
`String`	`message()` A description of the most recent details about processing the batch prediction request.
`String`	`mlModelId()` The ID of the `MLModel` that generated predictions for the `BatchPrediction` request.
`String`	`name()` A user-supplied name or description of the `BatchPrediction`.
`String`	`outputUri()` The location of an Amazon S3 bucket or directory to receive the operation results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchPrediction.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` Returns the value of the StartedAt property for this object.
`EntityStatus`	`status()` The status of the `BatchPrediction`.
`String`	`statusAsString()` The status of the `BatchPrediction`.
`BatchPrediction.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Long`	`totalRecordCount()` Returns the value of the TotalRecordCount property for this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - batchPredictionId
```
public 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:
    
    The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
  - mlModelId
```
public String mlModelId()
```
    The ID of the MLModel that generated predictions for the BatchPrediction request.
    
    Returns:
    
    The ID of the MLModel that generated predictions for the BatchPrediction request.
  - batchPredictionDataSourceId
```
public String batchPredictionDataSourceId()
```
    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.
  - inputDataLocationS3
```
public String inputDataLocationS3()
```
    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).
  - createdByIamUser
```
public 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:
    
    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.
  - createdAt
```
public Instant createdAt()
```
    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.
  - lastUpdatedAt
```
public Instant lastUpdatedAt()
```
    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.
  - name
```
public String name()
```
    A user-supplied name or description of the BatchPrediction.
    
    Returns:
    
    A user-supplied name or description of the BatchPrediction.
  - status
```
public 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 perform 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.
    If the service returns an enum value that is not available in the current SDK version, status will return EntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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 perform 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
  - statusAsString
```
public String statusAsString()
```
    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 perform 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.
    If the service returns an enum value that is not available in the current SDK version, status will return EntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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 perform 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
  - outputUri
```
public 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:
    
    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: ':', '//', '/./', '/../'.
  - message
```
public String message()
```
    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.
  - computeTime
```
public Long computeTime()
```
    Returns the value of the ComputeTime property for this object.
    
    Returns:
    
    The value of the ComputeTime property for this object.
  - finishedAt
```
public Instant finishedAt()
```
    Returns the value of the FinishedAt property for this object.
    
    Returns:
    
    The value of the FinishedAt property for this object.
  - startedAt
```
public Instant startedAt()
```
    Returns the value of the StartedAt property for this object.
    
    Returns:
    
    The value of the StartedAt property for this object.
  - totalRecordCount
```
public Long totalRecordCount()
```
    Returns the value of the TotalRecordCount property for this object.
    
    Returns:
    
    The value of the TotalRecordCount property for this object.
  - invalidRecordCount
```
public Long invalidRecordCount()
```
    Returns the value of the InvalidRecordCount property for this object.
    
    Returns:
    
    The value of the InvalidRecordCount property for this object.
  - toBuilder
```
public BatchPrediction.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchPrediction.Builder,BatchPrediction>
    
    Returns:
    
    a builder for type T
  - builder
```
public static BatchPrediction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchPrediction.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class BatchPrediction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

batchPredictionId

mlModelId

batchPredictionDataSourceId

inputDataLocationS3

createdByIamUser

createdAt

lastUpdatedAt

name

status

statusAsString

outputUri

message

computeTime

finishedAt

startedAt

totalRecordCount

invalidRecordCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields