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

Interface BatchPrediction.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BatchPrediction.Builder,BatchPrediction>, SdkBuilder<BatchPrediction.Builder,BatchPrediction>, SdkPojo
Enclosing class:
BatchPrediction
public static interface BatchPrediction.Builder extends SdkPojo, CopyableBuilder<BatchPrediction.Builder,BatchPrediction>

  • Method Details

    • batchPredictionId

      BatchPrediction.Builder batchPredictionId(String batchPredictionId)

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

      Parameters:
      batchPredictionId - The 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

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

      BatchPrediction.Builder batchPredictionDataSourceId(String batchPredictionDataSourceId)

      The ID of the DataSource that points to the group of observations to predict.

      Parameters:
      batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataLocationS3

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

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

      BatchPrediction.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - The time that 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

      BatchPrediction.Builder lastUpdatedAt(Instant lastUpdatedAt)

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

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

    • name

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

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

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

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

    • status

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

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

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

    • outputUri

      BatchPrediction.Builder outputUri(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: ':', '//', '/./', '/../'.

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

    • message

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

      BatchPrediction.Builder computeTime(Long computeTime)
      Sets the value of the ComputeTime property for this object.
      Parameters:
      computeTime - The new value for the ComputeTime property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • finishedAt

      BatchPrediction.Builder finishedAt(Instant finishedAt)
      Sets the value of the FinishedAt property for this object.
      Parameters:
      finishedAt - The new value for the FinishedAt property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      BatchPrediction.Builder startedAt(Instant startedAt)
      Sets the value of the StartedAt property for this object.
      Parameters:
      startedAt - The new value for the StartedAt property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRecordCount

      BatchPrediction.Builder totalRecordCount(Long totalRecordCount)
      Sets the value of the TotalRecordCount property for this object.
      Parameters:
      totalRecordCount - The new value for the TotalRecordCount property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invalidRecordCount

      BatchPrediction.Builder invalidRecordCount(Long invalidRecordCount)
      Sets the value of the InvalidRecordCount property for this object.
      Parameters:
      invalidRecordCount - The new value for the InvalidRecordCount property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.