Class BatchPrediction

java.lang.Object
software.amazon.awssdk.services.machinelearning.model.BatchPrediction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BatchPrediction.Builder,BatchPrediction>
@Generated("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:

  • Method Details

    • batchPredictionId

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

    • statusAsString

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

    • outputUri

      public final 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 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()
      Returns the value of the ComputeTime property for this object.
      Returns:
      The value of the ComputeTime property for this object.

    • finishedAt

      public final Instant finishedAt()
      Returns the value of the FinishedAt property for this object.
      Returns:
      The value of the FinishedAt property for this object.

    • startedAt

      public final Instant startedAt()
      Returns the value of the StartedAt property for this object.
      Returns:
      The value of the StartedAt property for this object.

    • totalRecordCount

      public final Long totalRecordCount()
      Returns the value of the TotalRecordCount property for this object.
      Returns:
      The value of the TotalRecordCount property for this object.

    • invalidRecordCount

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

    • equals

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

    • 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)

    • 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.