com.amazonaws.services.machinelearning.model.BatchPrediction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* 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.
*
*/
public class BatchPrediction implements Serializable, Cloneable {
/**
*
* 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:
*
*
* -
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.
*
*/
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;
/**
*
* 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:
*
*
* -
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.
*
*
* @param 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.
* @see EntityStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
* @return 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 EntityStatus
*/
public String getStatus() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see EntityStatus
*/
public BatchPrediction withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see EntityStatus
*/
public void setStatus(EntityStatus status) {
this.status = status.toString();
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see EntityStatus
*/
public BatchPrediction withStatus(EntityStatus status) {
setStatus(status);
return this;
}
/**
*
* 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: ':',
* '//', '/./', '/../'.
*
*
* @param 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:
* ':', '//', '/./', '/../'.
*/
public void setOutputUri(String outputUri) {
this.outputUri = 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: ':',
* '//', '/./', '/../'.
*
*
* @return 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: ':', '//', '/./', '/../'.
*/
public String getOutputUri() {
return this.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: ':',
* '//', '/./', '/../'.
*
*
* @param 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:
* ':', '//', '/./', '/../'.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public BatchPrediction withOutputUri(String outputUri) {
setOutputUri(outputUri);
return this;
}
/**
*
* A description of the most recent details about processing the batch
* prediction request.
*
*
* @param message
* A description of the most recent details about processing the
* batch prediction request.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* A description of the most recent details about processing the batch
* prediction request.
*
*
* @return A description of the most recent details about processing the
* batch prediction request.
*/
public String getMessage() {
return this.message;
}
/**
*
* A description of the most recent details about processing the batch
* prediction request.
*
*
* @param message
* A description of the most recent details about processing the
* batch prediction request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public BatchPrediction withMessage(String message) {
setMessage(message);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBatchPredictionId() != null)
sb.append("BatchPredictionId: " + getBatchPredictionId() + ",");
if (getMLModelId() != null)
sb.append("MLModelId: " + getMLModelId() + ",");
if (getBatchPredictionDataSourceId() != null)
sb.append("BatchPredictionDataSourceId: "
+ getBatchPredictionDataSourceId() + ",");
if (getInputDataLocationS3() != null)
sb.append("InputDataLocationS3: " + getInputDataLocationS3() + ",");
if (getCreatedByIamUser() != null)
sb.append("CreatedByIamUser: " + getCreatedByIamUser() + ",");
if (getCreatedAt() != null)
sb.append("CreatedAt: " + getCreatedAt() + ",");
if (getLastUpdatedAt() != null)
sb.append("LastUpdatedAt: " + getLastUpdatedAt() + ",");
if (getName() != null)
sb.append("Name: " + getName() + ",");
if (getStatus() != null)
sb.append("Status: " + getStatus() + ",");
if (getOutputUri() != null)
sb.append("OutputUri: " + getOutputUri() + ",");
if (getMessage() != null)
sb.append("Message: " + getMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchPrediction == false)
return false;
BatchPrediction other = (BatchPrediction) obj;
if (other.getBatchPredictionId() == null
^ this.getBatchPredictionId() == null)
return false;
if (other.getBatchPredictionId() != null
&& other.getBatchPredictionId().equals(
this.getBatchPredictionId()) == false)
return false;
if (other.getMLModelId() == null ^ this.getMLModelId() == null)
return false;
if (other.getMLModelId() != null
&& other.getMLModelId().equals(this.getMLModelId()) == false)
return false;
if (other.getBatchPredictionDataSourceId() == null
^ this.getBatchPredictionDataSourceId() == null)
return false;
if (other.getBatchPredictionDataSourceId() != null
&& other.getBatchPredictionDataSourceId().equals(
this.getBatchPredictionDataSourceId()) == false)
return false;
if (other.getInputDataLocationS3() == null
^ this.getInputDataLocationS3() == null)
return false;
if (other.getInputDataLocationS3() != null
&& other.getInputDataLocationS3().equals(
this.getInputDataLocationS3()) == false)
return false;
if (other.getCreatedByIamUser() == null
^ this.getCreatedByIamUser() == null)
return false;
if (other.getCreatedByIamUser() != null
&& other.getCreatedByIamUser().equals(
this.getCreatedByIamUser()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null
&& other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getLastUpdatedAt() == null ^ this.getLastUpdatedAt() == null)
return false;
if (other.getLastUpdatedAt() != null
&& other.getLastUpdatedAt().equals(this.getLastUpdatedAt()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null
&& other.getName().equals(this.getName()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null
&& other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getOutputUri() == null ^ this.getOutputUri() == null)
return false;
if (other.getOutputUri() != null
&& other.getOutputUri().equals(this.getOutputUri()) == false)
return false;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null
&& other.getMessage().equals(this.getMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getBatchPredictionId() == null) ? 0
: getBatchPredictionId().hashCode());
hashCode = prime * hashCode
+ ((getMLModelId() == null) ? 0 : getMLModelId().hashCode());
hashCode = prime
* hashCode
+ ((getBatchPredictionDataSourceId() == null) ? 0
: getBatchPredictionDataSourceId().hashCode());
hashCode = prime
* hashCode
+ ((getInputDataLocationS3() == null) ? 0
: getInputDataLocationS3().hashCode());
hashCode = prime
* hashCode
+ ((getCreatedByIamUser() == null) ? 0 : getCreatedByIamUser()
.hashCode());
hashCode = prime * hashCode
+ ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime
* hashCode
+ ((getLastUpdatedAt() == null) ? 0 : getLastUpdatedAt()
.hashCode());
hashCode = prime * hashCode
+ ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode
+ ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode
+ ((getOutputUri() == null) ? 0 : getOutputUri().hashCode());
hashCode = prime * hashCode
+ ((getMessage() == null) ? 0 : getMessage().hashCode());
return hashCode;
}
@Override
public BatchPrediction clone() {
try {
return (BatchPrediction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}