/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.machinelearning.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class BatchPrediction implements Serializable, Cloneable, StructuredPojo { /** *

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

*/ private String batchPredictionId; /** *

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

*/ private String mLModelId; /** *

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

*/ private String batchPredictionDataSourceId; /** *

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

*/ private String inputDataLocationS3; /** *

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

*/ private String createdByIamUser; /** *

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

*/ private java.util.Date createdAt; /** *

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

*/ private java.util.Date lastUpdatedAt; /** *

* A user-supplied name or description of the BatchPrediction. *

*/ private String name; /** *

* The status of the BatchPrediction. This element can have one of the following values: *

* */ private String status; /** *

* 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: ':', '//', '/./', '/../'. *

*/ private String outputUri; /** *

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

*/ private String message; private Long computeTime; private java.util.Date finishedAt; private java.util.Date startedAt; private Long totalRecordCount; private Long invalidRecordCount; /** *

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

* * @param batchPredictionId * The ID assigned to the BatchPrediction at creation. This value should be identical to the * value of the BatchPredictionID in the request. */ public void setBatchPredictionId(String batchPredictionId) { this.batchPredictionId = batchPredictionId; } /** *

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

* * @return The ID assigned to the BatchPrediction at creation. This value should be identical to the * value of the BatchPredictionID in the request. */ public String getBatchPredictionId() { return this.batchPredictionId; } /** *

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

* * @param batchPredictionId * The ID assigned to the BatchPrediction at creation. This value should be identical to the * value of the BatchPredictionID in the request. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withBatchPredictionId(String batchPredictionId) { setBatchPredictionId(batchPredictionId); return this; } /** *

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

* * @param mLModelId * The ID of the MLModel that generated predictions for the BatchPrediction * request. */ public void setMLModelId(String mLModelId) { this.mLModelId = mLModelId; } /** *

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

* * @return The ID of the MLModel that generated predictions for the BatchPrediction * request. */ public String getMLModelId() { return this.mLModelId; } /** *

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

* * @param mLModelId * The ID of the MLModel that generated predictions for the BatchPrediction * request. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withMLModelId(String mLModelId) { setMLModelId(mLModelId); return this; } /** *

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

* * @param batchPredictionDataSourceId * The ID of the DataSource that points to the group of observations to predict. */ public void setBatchPredictionDataSourceId(String batchPredictionDataSourceId) { this.batchPredictionDataSourceId = batchPredictionDataSourceId; } /** *

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

* * @return The ID of the DataSource that points to the group of observations to predict. */ public String getBatchPredictionDataSourceId() { return this.batchPredictionDataSourceId; } /** *

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

* * @param batchPredictionDataSourceId * The ID of the DataSource that points to the group of observations to predict. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withBatchPredictionDataSourceId(String batchPredictionDataSourceId) { setBatchPredictionDataSourceId(batchPredictionDataSourceId); return this; } /** *

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

* * @param inputDataLocationS3 * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). */ public void setInputDataLocationS3(String inputDataLocationS3) { this.inputDataLocationS3 = inputDataLocationS3; } /** *

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

* * @return The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). */ public String getInputDataLocationS3() { return this.inputDataLocationS3; } /** *

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

* * @param inputDataLocationS3 * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withInputDataLocationS3(String inputDataLocationS3) { setInputDataLocationS3(inputDataLocationS3); return this; } /** *

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

* * @param 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. */ public void setCreatedByIamUser(String createdByIamUser) { this.createdByIamUser = 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. *

* * @return 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. */ public String getCreatedByIamUser() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withCreatedByIamUser(String createdByIamUser) { setCreatedByIamUser(createdByIamUser); return this; } /** *

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

* * @param createdAt * The time that the BatchPrediction was created. The time is expressed in epoch time. */ public void setCreatedAt(java.util.Date createdAt) { this.createdAt = createdAt; } /** *

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

* * @return The time that the BatchPrediction was created. The time is expressed in epoch time. */ public java.util.Date getCreatedAt() { return this.createdAt; } /** *

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

* * @param createdAt * The time that the BatchPrediction was created. The time is expressed in epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withCreatedAt(java.util.Date createdAt) { setCreatedAt(createdAt); return this; } /** *

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

* * @param lastUpdatedAt * The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time. */ public void setLastUpdatedAt(java.util.Date lastUpdatedAt) { this.lastUpdatedAt = lastUpdatedAt; } /** *

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

* * @return The time of the most recent edit to the BatchPrediction. The time is expressed in epoch * time. */ public java.util.Date getLastUpdatedAt() { return this.lastUpdatedAt; } /** *

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

* * @param lastUpdatedAt * The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withLastUpdatedAt(java.util.Date lastUpdatedAt) { setLastUpdatedAt(lastUpdatedAt); return this; } /** *

* A user-supplied name or description of the BatchPrediction. *

* * @param name * A user-supplied name or description of the BatchPrediction. */ public void setName(String name) { this.name = name; } /** *

* A user-supplied name or description of the BatchPrediction. *

* * @return A user-supplied name or description of the BatchPrediction. */ public String getName() { return this.name; } /** *

* A user-supplied name or description of the BatchPrediction. *

* * @param name * A user-supplied name or description of the BatchPrediction. * @return Returns a reference to this object so that method calls can be chained together. */ public BatchPrediction withName(String name) { setName(name); return this; } /** *

* The status of the BatchPrediction. This element can have one of the following values: *

* * * @param status * The status of the BatchPrediction. This element can have one of the following values:

*