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

Interface GetBatchPredictionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>, MachineLearningResponse.Builder, SdkBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetBatchPredictionResponse
public static interface GetBatchPredictionResponse.Builder extends MachineLearningResponse.Builder, SdkPojo, CopyableBuilder<GetBatchPredictionResponse.Builder,GetBatchPredictionResponse>

  • Method Details

    • batchPredictionId

      GetBatchPredictionResponse.Builder batchPredictionId(String batchPredictionId)

      An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

      Parameters:
      batchPredictionId - An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mlModelId

      GetBatchPredictionResponse.Builder mlModelId(String mlModelId)

      The ID of the MLModel that generated predictions for the BatchPrediction request.

      Parameters:
      mlModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • batchPredictionDataSourceId

      GetBatchPredictionResponse.Builder batchPredictionDataSourceId(String batchPredictionDataSourceId)

      The ID of the DataSource that was used to create the BatchPrediction.

      Parameters:
      batchPredictionDataSourceId - The ID of the DataSource that was used to create the BatchPrediction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataLocationS3

      GetBatchPredictionResponse.Builder inputDataLocationS3(String inputDataLocationS3)

      The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

      Parameters:
      inputDataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdByIamUser

      GetBatchPredictionResponse.Builder createdByIamUser(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      GetBatchPredictionResponse.Builder createdAt(Instant createdAt)

      The time when the BatchPrediction was created. The time is expressed in epoch time.

      Parameters:
      createdAt - The time when the BatchPrediction was created. The time is expressed in epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      GetBatchPredictionResponse.Builder lastUpdatedAt(Instant lastUpdatedAt)

      The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

      Parameters:
      lastUpdatedAt - The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetBatchPredictionResponse.Builder name(String name)

      A user-supplied name or description of the BatchPrediction.

      Parameters:
      name - A user-supplied name or description of the BatchPrediction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetBatchPredictionResponse.Builder status(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetBatchPredictionResponse.Builder status(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputUri

      GetBatchPredictionResponse.Builder outputUri(String outputUri)

      The location of an Amazon S3 bucket or directory to receive the operation results.

      Parameters:
      outputUri - The location of an Amazon S3 bucket or directory to receive the operation results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logUri

      GetBatchPredictionResponse.Builder logUri(String logUri)

      A link to the file that contains logs of the CreateBatchPrediction operation.

      Parameters:
      logUri - A link to the file that contains logs of the CreateBatchPrediction operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • message

      GetBatchPredictionResponse.Builder message(String message)

      A description of the most recent details about processing the batch prediction request.

      Parameters:
      message - A description of the most recent details about processing the batch prediction request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeTime

      GetBatchPredictionResponse.Builder computeTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • finishedAt

      GetBatchPredictionResponse.Builder finishedAt(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      GetBatchPredictionResponse.Builder startedAt(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • totalRecordCount

      GetBatchPredictionResponse.Builder totalRecordCount(Long totalRecordCount)

      The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

      Parameters:
      totalRecordCount - The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invalidRecordCount

      GetBatchPredictionResponse.Builder invalidRecordCount(Long invalidRecordCount)

      The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

      Parameters:
      invalidRecordCount - The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.