com.amazonaws.services.forecast.model

Class DescribeDatasetImportJobResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.forecast.model.DescribeDatasetImportJobResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDatasetImportJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeDatasetImportJobResult()

Method Summary

Modifier and Type	Method and Description
DescribeDatasetImportJobResult	addFieldStatisticsEntry(String key, Statistics value)
DescribeDatasetImportJobResult	clearFieldStatisticsEntries() Removes all the entries added into FieldStatistics.
DescribeDatasetImportJobResult	clone()
boolean	equals(Object obj)
Date	getCreationTime() When the dataset import job was created.
String	getDatasetArn() The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
String	getDatasetImportJobArn() The ARN of the dataset import job.
String	getDatasetImportJobName() The name of the dataset import job.
Double	getDataSize() The size of the dataset in gigabytes (GB) after the import job has finished.
DataSource	getDataSource() 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.
Map<String,Statistics>	getFieldStatistics() Statistical information about each field in the input data.
Date	getLastModificationTime() The last time that the dataset was modified.
String	getMessage() If an error occurred, an informational message about the error.
String	getStatus() The status of the dataset import job.
String	getTimestampFormat() The format of timestamps in the dataset.
int	hashCode()
void	setCreationTime(Date creationTime) When the dataset import job was created.
void	setDatasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
void	setDatasetImportJobArn(String datasetImportJobArn) The ARN of the dataset import job.
void	setDatasetImportJobName(String datasetImportJobName) The name of the dataset import job.
void	setDataSize(Double dataSize) The size of the dataset in gigabytes (GB) after the import job has finished.
void	setDataSource(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.
void	setFieldStatistics(Map<String,Statistics> fieldStatistics) Statistical information about each field in the input data.
void	setLastModificationTime(Date lastModificationTime) The last time that the dataset was modified.
void	setMessage(String message) If an error occurred, an informational message about the error.
void	setStatus(String status) The status of the dataset import job.
void	setTimestampFormat(String timestampFormat) The format of timestamps in the dataset.
String	toString() Returns a string representation of this object.
DescribeDatasetImportJobResult	withCreationTime(Date creationTime) When the dataset import job was created.
DescribeDatasetImportJobResult	withDatasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
DescribeDatasetImportJobResult	withDatasetImportJobArn(String datasetImportJobArn) The ARN of the dataset import job.
DescribeDatasetImportJobResult	withDatasetImportJobName(String datasetImportJobName) The name of the dataset import job.
DescribeDatasetImportJobResult	withDataSize(Double dataSize) The size of the dataset in gigabytes (GB) after the import job has finished.
DescribeDatasetImportJobResult	withDataSource(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.
DescribeDatasetImportJobResult	withFieldStatistics(Map<String,Statistics> fieldStatistics) Statistical information about each field in the input data.
DescribeDatasetImportJobResult	withLastModificationTime(Date lastModificationTime) The last time that the dataset was modified.
DescribeDatasetImportJobResult	withMessage(String message) If an error occurred, an informational message about the error.
DescribeDatasetImportJobResult	withStatus(String status) The status of the dataset import job.
DescribeDatasetImportJobResult	withTimestampFormat(String timestampFormat) The format of timestamps in the dataset.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDatasetImportJobResult

public DescribeDatasetImportJobResult()

Method Detail

setDatasetImportJobName

public void setDatasetImportJobName(String datasetImportJobName)

The name of the dataset import job.

Parameters:

datasetImportJobName - The name of the dataset import job.

getDatasetImportJobName

public String getDatasetImportJobName()

The name of the dataset import job.

Returns:

The name of the dataset import job.

withDatasetImportJobName

public DescribeDatasetImportJobResult withDatasetImportJobName(String datasetImportJobName)

The name of the dataset import job.

Parameters:

datasetImportJobName - The name of the dataset import job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatasetImportJobArn

public void setDatasetImportJobArn(String datasetImportJobArn)

The ARN of the dataset import job.

Parameters:

datasetImportJobArn - The ARN of the dataset import job.

getDatasetImportJobArn

public String getDatasetImportJobArn()

The ARN of the dataset import job.

Returns:

The ARN of the dataset import job.

withDatasetImportJobArn

public DescribeDatasetImportJobResult withDatasetImportJobArn(String datasetImportJobArn)

The ARN of the dataset import job.

Parameters:

datasetImportJobArn - The ARN of the dataset import job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatasetArn

public void setDatasetArn(String datasetArn)

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Parameters:

datasetArn - The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

getDatasetArn

public String getDatasetArn()

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Returns:

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

withDatasetArn

public DescribeDatasetImportJobResult withDatasetArn(String datasetArn)

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Parameters:

datasetArn - The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimestampFormat

public void setTimestampFormat(String 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

Parameters:

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

getTimestampFormat

public String getTimestampFormat()

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

Returns:

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

withTimestampFormat

public DescribeDatasetImportJobResult withTimestampFormat(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataSource

public void setDataSource(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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Parameters:

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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

getDataSource

public DataSource getDataSource()

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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Returns:

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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

withDataSource

public DescribeDatasetImportJobResult withDataSource(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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Parameters:

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.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFieldStatistics

public Map<String,Statistics> getFieldStatistics()

Statistical information about each field in the input data.

Returns:

Statistical information about each field in the input data.

setFieldStatistics

public void setFieldStatistics(Map<String,Statistics> fieldStatistics)

Statistical information about each field in the input data.

Parameters:

fieldStatistics - Statistical information about each field in the input data.

withFieldStatistics

public DescribeDatasetImportJobResult withFieldStatistics(Map<String,Statistics> fieldStatistics)

Statistical information about each field in the input data.

Parameters:

fieldStatistics - Statistical information about each field in the input data.

Returns:

Returns a reference to this object so that method calls can be chained together.

addFieldStatisticsEntry

public DescribeDatasetImportJobResult addFieldStatisticsEntry(String key,
                                                              Statistics value)

clearFieldStatisticsEntries

public DescribeDatasetImportJobResult clearFieldStatisticsEntries()

Removes all the entries added into FieldStatistics.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataSize

public void setDataSize(Double dataSize)

The size of the dataset in gigabytes (GB) after the import job has finished.

Parameters:

dataSize - The size of the dataset in gigabytes (GB) after the import job has finished.

getDataSize

public Double getDataSize()

The size of the dataset in gigabytes (GB) after the import job has finished.

Returns:

The size of the dataset in gigabytes (GB) after the import job has finished.

withDataSize

public DescribeDatasetImportJobResult withDataSize(Double dataSize)

The size of the dataset in gigabytes (GB) after the import job has finished.

Parameters:

dataSize - The size of the dataset in gigabytes (GB) after the import job has finished.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Parameters:

status - The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

getStatus

public String getStatus()

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

withStatus

public DescribeDatasetImportJobResult withStatus(String status)

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Parameters:

status - The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessage

public void setMessage(String message)

If an error occurred, an informational message about the error.

Parameters:

message - If an error occurred, an informational message about the error.

getMessage

public String getMessage()

If an error occurred, an informational message about the error.

Returns:

If an error occurred, an informational message about the error.

withMessage

public DescribeDatasetImportJobResult withMessage(String message)

If an error occurred, an informational message about the error.

Parameters:

message - If an error occurred, an informational message about the error.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreationTime

public void setCreationTime(Date creationTime)

When the dataset import job was created.

Parameters:

creationTime - When the dataset import job was created.

getCreationTime

public Date getCreationTime()

When the dataset import job was created.

Returns:

When the dataset import job was created.

withCreationTime

public DescribeDatasetImportJobResult withCreationTime(Date creationTime)

When the dataset import job was created.

Parameters:

creationTime - When the dataset import job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLastModificationTime

public void setLastModificationTime(Date lastModificationTime)

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Parameters:

lastModificationTime - The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

getLastModificationTime

public Date getLastModificationTime()

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

withLastModificationTime

public DescribeDatasetImportJobResult withLastModificationTime(Date lastModificationTime)

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Parameters:

lastModificationTime - The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeDatasetImportJobResult clone()

Overrides:

clone in class Object