Package software.amazon.awssdk.services.machinelearning.model

Class GetBatchPredictionResponse

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:
SdkPojo, ToCopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetBatchPredictionResponse extends MachineLearningResponse implements ToCopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>

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

  • Method Details

    • batchPredictionId

      public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final String name()

      A user-supplied name or description of the BatchPrediction.

      Returns:
      A user-supplied name or description of the BatchPrediction.

    • status

      public final 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:

    • statusAsString

      public final 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:

    • outputUri

      public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <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

    • sdkFields

      public final 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.