com.amazonaws.services.forecast.model.DescribeDatasetResult 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDatasetResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the dataset.
*
*/
private String datasetArn;
/**
*
* The name of the dataset.
*
*/
private String datasetName;
/**
*
* The domain associated with the dataset.
*
*/
private String domain;
/**
*
* The dataset type.
*
*/
private String datasetType;
/**
*
* The frequency of data collection.
*
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
* 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min"
* indicates every 30 minutes.
*
*/
private String dataFrequency;
/**
*
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*
*/
private Schema schema;
/**
*
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can
* assume to access the key.
*
*/
private EncryptionConfig encryptionConfig;
/**
*
* The status of the dataset. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob
* operation and reflect the status of the dataset import job. For example, when the import job status is
* CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*
*/
private String status;
/**
*
* When the dataset was created.
*
*/
private java.util.Date creationTime;
/**
*
* When you create a dataset, LastModificationTime is the same as CreationTime. While data
* is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob
* operation has finished, LastModificationTime is when the import job completed or failed.
*
*/
private java.util.Date lastModificationTime;
/**
*
* The Amazon Resource Name (ARN) of the dataset.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the dataset.
*/
public void setDatasetArn(String datasetArn) {
this.datasetArn = datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset.
*
*
* @return The Amazon Resource Name (ARN) of the dataset.
*/
public String getDatasetArn() {
return this.datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withDatasetArn(String datasetArn) {
setDatasetArn(datasetArn);
return this;
}
/**
*
* The name of the dataset.
*
*
* @param datasetName
* The name of the dataset.
*/
public void setDatasetName(String datasetName) {
this.datasetName = datasetName;
}
/**
*
* The name of the dataset.
*
*
* @return The name of the dataset.
*/
public String getDatasetName() {
return this.datasetName;
}
/**
*
* The name of the dataset.
*
*
* @param datasetName
* The name of the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withDatasetName(String datasetName) {
setDatasetName(datasetName);
return this;
}
/**
*
* The domain associated with the dataset.
*
*
* @param domain
* The domain associated with the dataset.
* @see Domain
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* The domain associated with the dataset.
*
*
* @return The domain associated with the dataset.
* @see Domain
*/
public String getDomain() {
return this.domain;
}
/**
*
* The domain associated with the dataset.
*
*
* @param domain
* The domain associated with the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
public DescribeDatasetResult withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The domain associated with the dataset.
*
*
* @param domain
* The domain associated with the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
public DescribeDatasetResult withDomain(Domain domain) {
this.domain = domain.toString();
return this;
}
/**
*
* The dataset type.
*
*
* @param datasetType
* The dataset type.
* @see DatasetType
*/
public void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
/**
*
* The dataset type.
*
*
* @return The dataset type.
* @see DatasetType
*/
public String getDatasetType() {
return this.datasetType;
}
/**
*
* The dataset type.
*
*
* @param datasetType
* The dataset type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetType
*/
public DescribeDatasetResult withDatasetType(String datasetType) {
setDatasetType(datasetType);
return this;
}
/**
*
* The dataset type.
*
*
* @param datasetType
* The dataset type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetType
*/
public DescribeDatasetResult withDatasetType(DatasetType datasetType) {
this.datasetType = datasetType.toString();
return this;
}
/**
*
* The frequency of data collection.
*
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
* 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min"
* indicates every 30 minutes.
*
*
* @param dataFrequency
* The frequency of data collection.
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15
* minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every
* month and "30min" indicates every 30 minutes.
*/
public void setDataFrequency(String dataFrequency) {
this.dataFrequency = dataFrequency;
}
/**
*
* The frequency of data collection.
*
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
* 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min"
* indicates every 30 minutes.
*
*
* @return The frequency of data collection.
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15
* minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every
* month and "30min" indicates every 30 minutes.
*/
public String getDataFrequency() {
return this.dataFrequency;
}
/**
*
* The frequency of data collection.
*
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
* 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min"
* indicates every 30 minutes.
*
*
* @param dataFrequency
* The frequency of data collection.
*
* Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15
* minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every
* month and "30min" indicates every 30 minutes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withDataFrequency(String dataFrequency) {
setDataFrequency(dataFrequency);
return this;
}
/**
*
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*
*
* @param schema
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*/
public void setSchema(Schema schema) {
this.schema = schema;
}
/**
*
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*
*
* @return An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*/
public Schema getSchema() {
return this.schema;
}
/**
*
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
*
*
* @param schema
* An array of SchemaAttribute objects that specify the dataset fields. Each
* SchemaAttribute specifies the name and data type of a field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withSchema(Schema schema) {
setSchema(schema);
return this;
}
/**
*
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can
* assume to access the key.
*
*
* @param encryptionConfig
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the key.
*/
public void setEncryptionConfig(EncryptionConfig encryptionConfig) {
this.encryptionConfig = encryptionConfig;
}
/**
*
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can
* assume to access the key.
*
*
* @return The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the key.
*/
public EncryptionConfig getEncryptionConfig() {
return this.encryptionConfig;
}
/**
*
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can
* assume to access the key.
*
*
* @param encryptionConfig
* The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withEncryptionConfig(EncryptionConfig encryptionConfig) {
setEncryptionConfig(encryptionConfig);
return this;
}
/**
*
* The status of the dataset. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob
* operation and reflect the status of the dataset import job. For example, when the import job status is
* CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*
*
* @param status
* The status of the dataset. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when
* the import job status is CREATE_IN_PROGRESS, the status of the dataset is
* UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the dataset. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob
* operation and reflect the status of the dataset import job. For example, when the import job status is
* CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*
*
* @return The status of the dataset. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when
* the import job status is CREATE_IN_PROGRESS, the status of the dataset is
* UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the dataset. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob
* operation and reflect the status of the dataset import job. For example, when the import job status is
* CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
*
*
* @param status
* The status of the dataset. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
*
*
*
*
* The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when
* the import job status is CREATE_IN_PROGRESS, the status of the dataset is
* UPDATE_IN_PROGRESS.
*
*
*
* The Status of the dataset must be ACTIVE before you can import training data.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* When the dataset was created.
*
*
* @param creationTime
* When the dataset was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the dataset was created.
*
*
* @return When the dataset was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the dataset was created.
*
*
* @param creationTime
* When the dataset was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* When you create a dataset, LastModificationTime is the same as CreationTime. While data
* is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob
* operation has finished, LastModificationTime is when the import job completed or failed.
*
*
* @param lastModificationTime
* When you create a dataset, LastModificationTime is the same as CreationTime.
* While data is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import
* job completed or failed.
*/
public void setLastModificationTime(java.util.Date lastModificationTime) {
this.lastModificationTime = lastModificationTime;
}
/**
*
* When you create a dataset, LastModificationTime is the same as CreationTime. While data
* is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob
* operation has finished, LastModificationTime is when the import job completed or failed.
*
*
* @return When you create a dataset, LastModificationTime is the same as CreationTime.
* While data is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import
* job completed or failed.
*/
public java.util.Date getLastModificationTime() {
return this.lastModificationTime;
}
/**
*
* When you create a dataset, LastModificationTime is the same as CreationTime. While data
* is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob
* operation has finished, LastModificationTime is when the import job completed or failed.
*
*
* @param lastModificationTime
* When you create a dataset, LastModificationTime is the same as CreationTime.
* While data is being imported to the dataset, LastModificationTime is the current time of the
* DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import
* job completed or failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDatasetResult withLastModificationTime(java.util.Date lastModificationTime) {
setLastModificationTime(lastModificationTime);
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 (getDatasetArn() != null)
sb.append("DatasetArn: ").append(getDatasetArn()).append(",");
if (getDatasetName() != null)
sb.append("DatasetName: ").append(getDatasetName()).append(",");
if (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getDatasetType() != null)
sb.append("DatasetType: ").append(getDatasetType()).append(",");
if (getDataFrequency() != null)
sb.append("DataFrequency: ").append(getDataFrequency()).append(",");
if (getSchema() != null)
sb.append("Schema: ").append(getSchema()).append(",");
if (getEncryptionConfig() != null)
sb.append("EncryptionConfig: ").append(getEncryptionConfig()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastModificationTime() != null)
sb.append("LastModificationTime: ").append(getLastModificationTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDatasetResult == false)
return false;
DescribeDatasetResult other = (DescribeDatasetResult) obj;
if (other.getDatasetArn() == null ^ this.getDatasetArn() == null)
return false;
if (other.getDatasetArn() != null && other.getDatasetArn().equals(this.getDatasetArn()) == false)
return false;
if (other.getDatasetName() == null ^ this.getDatasetName() == null)
return false;
if (other.getDatasetName() != null && other.getDatasetName().equals(this.getDatasetName()) == false)
return false;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getDatasetType() == null ^ this.getDatasetType() == null)
return false;
if (other.getDatasetType() != null && other.getDatasetType().equals(this.getDatasetType()) == false)
return false;
if (other.getDataFrequency() == null ^ this.getDataFrequency() == null)
return false;
if (other.getDataFrequency() != null && other.getDataFrequency().equals(this.getDataFrequency()) == false)
return false;
if (other.getSchema() == null ^ this.getSchema() == null)
return false;
if (other.getSchema() != null && other.getSchema().equals(this.getSchema()) == false)
return false;
if (other.getEncryptionConfig() == null ^ this.getEncryptionConfig() == null)
return false;
if (other.getEncryptionConfig() != null && other.getEncryptionConfig().equals(this.getEncryptionConfig()) == 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.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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDatasetArn() == null) ? 0 : getDatasetArn().hashCode());
hashCode = prime * hashCode + ((getDatasetName() == null) ? 0 : getDatasetName().hashCode());
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getDatasetType() == null) ? 0 : getDatasetType().hashCode());
hashCode = prime * hashCode + ((getDataFrequency() == null) ? 0 : getDataFrequency().hashCode());
hashCode = prime * hashCode + ((getSchema() == null) ? 0 : getSchema().hashCode());
hashCode = prime * hashCode + ((getEncryptionConfig() == null) ? 0 : getEncryptionConfig().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastModificationTime() == null) ? 0 : getLastModificationTime().hashCode());
return hashCode;
}
@Override
public DescribeDatasetResult clone() {
try {
return (DescribeDatasetResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}