com.amazonaws.services.forecast.model.DatasetImportJobSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast Show documentation
/*
* Copyright 2019-2024 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.forecast.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides a summary of the dataset import job properties used in the ListDatasetImportJobs
* operation. To get the complete set of properties, call the DescribeDatasetImportJob
* operation, and provide the DatasetImportJobArn.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DatasetImportJobSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the dataset import job.
*
*/
private String datasetImportJobArn;
/**
*
* The name of the dataset import job.
*
*/
private String datasetImportJobName;
/**
*
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*
*/
private DataSource dataSource;
/**
*
* The status of the dataset import job. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*/
private String status;
/**
*
* If an error occurred, an informational message about the error.
*
*/
private String message;
/**
*
* When the dataset import job was created.
*
*/
private java.util.Date creationTime;
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*/
private java.util.Date lastModificationTime;
/**
*
* The import mode of the dataset import job, FULL or INCREMENTAL.
*
*/
private String importMode;
/**
*
* The Amazon Resource Name (ARN) of the dataset import job.
*
*
* @param datasetImportJobArn
* The Amazon Resource Name (ARN) of the dataset import job.
*/
public void setDatasetImportJobArn(String datasetImportJobArn) {
this.datasetImportJobArn = datasetImportJobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset import job.
*
*
* @return The Amazon Resource Name (ARN) of the dataset import job.
*/
public String getDatasetImportJobArn() {
return this.datasetImportJobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset import job.
*
*
* @param datasetImportJobArn
* The Amazon Resource Name (ARN) of the dataset import job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withDatasetImportJobArn(String datasetImportJobArn) {
setDatasetImportJobArn(datasetImportJobArn);
return this;
}
/**
*
* The name of the dataset import job.
*
*
* @param datasetImportJobName
* The name of the dataset import job.
*/
public void setDatasetImportJobName(String datasetImportJobName) {
this.datasetImportJobName = datasetImportJobName;
}
/**
*
* The name of the dataset import job.
*
*
* @return The name of the dataset import job.
*/
public String getDatasetImportJobName() {
return this.datasetImportJobName;
}
/**
*
* The name of the dataset import job.
*
*
* @param datasetImportJobName
* The name of the dataset import job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withDatasetImportJobName(String datasetImportJobName) {
setDatasetImportJobName(datasetImportJobName);
return this;
}
/**
*
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*
*
* @param dataSource
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*/
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
/**
*
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*
*
* @return The location of the training data to import and an Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*/
public DataSource getDataSource() {
return this.dataSource;
}
/**
*
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
*
*
* @param dataSource
* The location of the training data to import and an Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
*
* If encryption is used, DataSource includes an Key Management Service (KMS) key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withDataSource(DataSource dataSource) {
setDataSource(dataSource);
return this;
}
/**
*
* The status of the dataset import job. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
* @param status
* The status of the dataset import job. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the dataset import job. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
* @return The status of the dataset import job. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the dataset import job. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
* @param status
* The status of the dataset import job. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @return If an error occurred, an informational message about the error.
*/
public String getMessage() {
return this.message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* When the dataset import job was created.
*
*
* @param creationTime
* When the dataset import job was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the dataset import job was created.
*
*
* @return When the dataset import job was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the dataset import job was created.
*
*
* @param creationTime
* When the dataset import job was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @param lastModificationTime
* The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*/
public void setLastModificationTime(java.util.Date lastModificationTime) {
this.lastModificationTime = lastModificationTime;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @return The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*/
public java.util.Date getLastModificationTime() {
return this.lastModificationTime;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @param lastModificationTime
* The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DatasetImportJobSummary withLastModificationTime(java.util.Date lastModificationTime) {
setLastModificationTime(lastModificationTime);
return this;
}
/**
*
* The import mode of the dataset import job, FULL or INCREMENTAL.
*
*
* @param importMode
* The import mode of the dataset import job, FULL or INCREMENTAL.
* @see ImportMode
*/
public void setImportMode(String importMode) {
this.importMode = importMode;
}
/**
*
* The import mode of the dataset import job, FULL or INCREMENTAL.
*
*
* @return The import mode of the dataset import job, FULL or INCREMENTAL.
* @see ImportMode
*/
public String getImportMode() {
return this.importMode;
}
/**
*
* The import mode of the dataset import job, FULL or INCREMENTAL.
*
*
* @param importMode
* The import mode of the dataset import job, FULL or INCREMENTAL.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImportMode
*/
public DatasetImportJobSummary withImportMode(String importMode) {
setImportMode(importMode);
return this;
}
/**
*
* The import mode of the dataset import job, FULL or INCREMENTAL.
*
*
* @param importMode
* The import mode of the dataset import job, FULL or INCREMENTAL.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImportMode
*/
public DatasetImportJobSummary withImportMode(ImportMode importMode) {
this.importMode = importMode.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDatasetImportJobArn() != null)
sb.append("DatasetImportJobArn: ").append(getDatasetImportJobArn()).append(",");
if (getDatasetImportJobName() != null)
sb.append("DatasetImportJobName: ").append(getDatasetImportJobName()).append(",");
if (getDataSource() != null)
sb.append("DataSource: ").append(getDataSource()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getMessage() != null)
sb.append("Message: ").append(getMessage()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastModificationTime() != null)
sb.append("LastModificationTime: ").append(getLastModificationTime()).append(",");
if (getImportMode() != null)
sb.append("ImportMode: ").append(getImportMode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DatasetImportJobSummary == false)
return false;
DatasetImportJobSummary other = (DatasetImportJobSummary) obj;
if (other.getDatasetImportJobArn() == null ^ this.getDatasetImportJobArn() == null)
return false;
if (other.getDatasetImportJobArn() != null && other.getDatasetImportJobArn().equals(this.getDatasetImportJobArn()) == false)
return false;
if (other.getDatasetImportJobName() == null ^ this.getDatasetImportJobName() == null)
return false;
if (other.getDatasetImportJobName() != null && other.getDatasetImportJobName().equals(this.getDatasetImportJobName()) == false)
return false;
if (other.getDataSource() == null ^ this.getDataSource() == null)
return false;
if (other.getDataSource() != null && other.getDataSource().equals(this.getDataSource()) == 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.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getLastModificationTime() == null ^ this.getLastModificationTime() == null)
return false;
if (other.getLastModificationTime() != null && other.getLastModificationTime().equals(this.getLastModificationTime()) == false)
return false;
if (other.getImportMode() == null ^ this.getImportMode() == null)
return false;
if (other.getImportMode() != null && other.getImportMode().equals(this.getImportMode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDatasetImportJobArn() == null) ? 0 : getDatasetImportJobArn().hashCode());
hashCode = prime * hashCode + ((getDatasetImportJobName() == null) ? 0 : getDatasetImportJobName().hashCode());
hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastModificationTime() == null) ? 0 : getLastModificationTime().hashCode());
hashCode = prime * hashCode + ((getImportMode() == null) ? 0 : getImportMode().hashCode());
return hashCode;
}
@Override
public DatasetImportJobSummary clone() {
try {
return (DatasetImportJobSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.forecast.model.transform.DatasetImportJobSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}