com.amazonaws.services.forecast.model.CreateDatasetImportJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast Show documentation
/*
* Copyright 2015-2020 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateDatasetImportJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name for the dataset import job. We recommend including the current timestamp in the name, for example,
* 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
* exception.
*
*/
private String datasetImportJobName;
/**
*
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*
*/
private String datasetArn;
/**
*
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and the IAM
* role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
* in the EncryptionConfig parameter of the CreateDataset operation.
*
*/
private DataSource dataSource;
/**
*
* The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
* specified when the dataset was created. The following formats are supported
*
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*
*/
private String timestampFormat;
/**
*
* The name for the dataset import job. We recommend including the current timestamp in the name, for example,
* 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
* exception.
*
*
* @param datasetImportJobName
* The name for the dataset import job. We recommend including the current timestamp in the name, for
* example, 20190721DatasetImport. This can help you avoid getting a
* ResourceAlreadyExistsException exception.
*/
public void setDatasetImportJobName(String datasetImportJobName) {
this.datasetImportJobName = datasetImportJobName;
}
/**
*
* The name for the dataset import job. We recommend including the current timestamp in the name, for example,
* 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
* exception.
*
*
* @return The name for the dataset import job. We recommend including the current timestamp in the name, for
* example, 20190721DatasetImport. This can help you avoid getting a
* ResourceAlreadyExistsException exception.
*/
public String getDatasetImportJobName() {
return this.datasetImportJobName;
}
/**
*
* The name for the dataset import job. We recommend including the current timestamp in the name, for example,
* 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
* exception.
*
*
* @param datasetImportJobName
* The name for the dataset import job. We recommend including the current timestamp in the name, for
* example, 20190721DatasetImport. This can help you avoid getting a
* ResourceAlreadyExistsException exception.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetImportJobRequest withDatasetImportJobName(String datasetImportJobName) {
setDatasetImportJobName(datasetImportJobName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*/
public void setDatasetArn(String datasetArn) {
this.datasetArn = datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*/
public String getDatasetArn() {
return this.datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetImportJobRequest withDatasetArn(String datasetArn) {
setDatasetArn(datasetArn);
return this;
}
/**
*
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and the IAM
* role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
* in the EncryptionConfig parameter of the CreateDataset operation.
*
*
* @param dataSource
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and
* the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match
* those specified in the EncryptionConfig parameter of the CreateDataset operation.
*/
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
/**
*
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and the IAM
* role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
* in the EncryptionConfig parameter of the CreateDataset operation.
*
*
* @return The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and
* the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match
* those specified in the EncryptionConfig parameter of the CreateDataset operation.
*/
public DataSource getDataSource() {
return this.dataSource;
}
/**
*
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and the IAM
* role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
* in the EncryptionConfig parameter of the CreateDataset operation.
*
*
* @param dataSource
* The location of the training data to import and an AWS 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 must include an AWS Key Management Service (KMS) key and
* the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match
* those specified in the EncryptionConfig parameter of the CreateDataset operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetImportJobRequest withDataSource(DataSource dataSource) {
setDataSource(dataSource);
return this;
}
/**
*
* The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
* specified when the dataset was created. The following formats are supported
*
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*
*
* @param timestampFormat
* The format of timestamps in the dataset. The format that you specify depends on the
* DataFrequency specified when the dataset was created. The following formats are supported
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*/
public void setTimestampFormat(String timestampFormat) {
this.timestampFormat = timestampFormat;
}
/**
*
* The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
* specified when the dataset was created. The following formats are supported
*
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*
*
* @return The format of timestamps in the dataset. The format that you specify depends on the
* DataFrequency specified when the dataset was created. The following formats are
* supported
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*/
public String getTimestampFormat() {
return this.timestampFormat;
}
/**
*
* The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
* specified when the dataset was created. The following formats are supported
*
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
*
*
* @param timestampFormat
* The format of timestamps in the dataset. The format that you specify depends on the
* DataFrequency specified when the dataset was created. The following formats are supported
*
* -
*
* "yyyy-MM-dd"
*
*
* For the following data frequencies: Y, M, W, and D
*
*
* -
*
* "yyyy-MM-dd HH:mm:ss"
*
*
* For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
*
*
*
*
* If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetImportJobRequest withTimestampFormat(String timestampFormat) {
setTimestampFormat(timestampFormat);
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 (getDatasetImportJobName() != null)
sb.append("DatasetImportJobName: ").append(getDatasetImportJobName()).append(",");
if (getDatasetArn() != null)
sb.append("DatasetArn: ").append(getDatasetArn()).append(",");
if (getDataSource() != null)
sb.append("DataSource: ").append(getDataSource()).append(",");
if (getTimestampFormat() != null)
sb.append("TimestampFormat: ").append(getTimestampFormat());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateDatasetImportJobRequest == false)
return false;
CreateDatasetImportJobRequest other = (CreateDatasetImportJobRequest) obj;
if (other.getDatasetImportJobName() == null ^ this.getDatasetImportJobName() == null)
return false;
if (other.getDatasetImportJobName() != null && other.getDatasetImportJobName().equals(this.getDatasetImportJobName()) == false)
return false;
if (other.getDatasetArn() == null ^ this.getDatasetArn() == null)
return false;
if (other.getDatasetArn() != null && other.getDatasetArn().equals(this.getDatasetArn()) == 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.getTimestampFormat() == null ^ this.getTimestampFormat() == null)
return false;
if (other.getTimestampFormat() != null && other.getTimestampFormat().equals(this.getTimestampFormat()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDatasetImportJobName() == null) ? 0 : getDatasetImportJobName().hashCode());
hashCode = prime * hashCode + ((getDatasetArn() == null) ? 0 : getDatasetArn().hashCode());
hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode());
hashCode = prime * hashCode + ((getTimestampFormat() == null) ? 0 : getTimestampFormat().hashCode());
return hashCode;
}
@Override
public CreateDatasetImportJobRequest clone() {
return (CreateDatasetImportJobRequest) super.clone();
}
}