GetBatchPredictionResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.machinelearning.model.MachineLearningResponse
    - - software.amazon.awssdk.services.machinelearning.model.GetBatchPredictionResponse

All Implemented Interfaces:: ToCopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class GetBatchPredictionResponse
extends MachineLearningResponse
implements ToCopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetBatchPredictionResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetBatchPredictionResponse.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 was used to create the `BatchPrediction`.
`String`	`batchPredictionId()` An ID assigned to the `BatchPrediction` at creation.
`static GetBatchPredictionResponse.Builder`	`builder()`
`Long`	`computeTime()` The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the `BatchPrediction`, normalized and scaled on computation resources.
`Instant`	`createdAt()` The time when the `BatchPrediction` was created.
`String`	`createdByIamUser()` The AWS user account that invoked the `BatchPrediction`.
`boolean`	`equals(Object obj)`
`Instant`	`finishedAt()` The epoch time when Amazon Machine Learning marked the `BatchPrediction` as `COMPLETED` or `FAILED`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`String`	`inputDataLocationS3()` The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
`Long`	`invalidRecordCount()` The number of invalid records that Amazon Machine Learning saw while processing the `BatchPrediction`.
`Instant`	`lastUpdatedAt()` The time of the most recent edit to `BatchPrediction`.
`String`	`logUri()` A link to the file that contains logs of the `CreateBatchPrediction` operation.
`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.
`static Class<? extends GetBatchPredictionResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The epoch time when Amazon Machine Learning marked the `BatchPrediction` as `INPROGRESS`.
`EntityStatus`	`status()` The status of the `BatchPrediction`, which can be one of the following values:
`String`	`statusAsString()` The status of the `BatchPrediction`, which can be one of the following values:
`GetBatchPredictionResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Long`	`totalRecordCount()` The number of total records that Amazon Machine Learning saw while processing the `BatchPrediction`.

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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()
```
    An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
    
    Returns:
    
    An 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 was used to create the BatchPrediction.
    
    Returns:
    
    The ID of the DataSource that was used to create the BatchPrediction.
  - 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 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.
  - lastUpdatedAt
```
public Instant lastUpdatedAt()
```
    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.
  - 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, 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 - 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, 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 - The BatchPrediction is marked as deleted. It is not usable.
    See Also:
    
    EntityStatus
  - statusAsString
```
public String statusAsString()
```
    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 - 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, 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 - 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.
    
    Returns:
    
    The location of an Amazon S3 bucket or directory to receive the operation results.
  - logUri
```
public String logUri()
```
    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.
  - 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()
```
    The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.
    
    Returns:
    
    The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.
  - finishedAt
```
public Instant finishedAt()
```
    The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.
    
    Returns:
    
    The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.
  - startedAt
```
public Instant startedAt()
```
    The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.
    
    Returns:
    
    The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.
  - totalRecordCount
```
public Long totalRecordCount()
```
    The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.
    
    Returns:
    
    The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.
  - invalidRecordCount
```
public Long invalidRecordCount()
```
    The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.
    
    Returns:
    
    The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.
  - toBuilder
```
public GetBatchPredictionResponse.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<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetBatchPredictionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetBatchPredictionResponse.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)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class GetBatchPredictionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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

logUri

message

computeTime

finishedAt

startedAt

totalRecordCount

invalidRecordCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField