com.amazonaws.services.forecast.model

Class DescribeDatasetResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.forecast.model.DescribeDatasetResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeDatasetResult()

Method Summary

Modifier and Type	Method and Description
DescribeDatasetResult	clone()
boolean	equals(Object obj)
Date	getCreationTime() When the dataset was created.
String	getDataFrequency() The frequency of data collection.
String	getDatasetArn() The Amazon Resource Name (ARN) of the dataset.
String	getDatasetName() The name of the dataset.
String	getDatasetType() The dataset type.
String	getDomain() The domain associated with the dataset.
EncryptionConfig	getEncryptionConfig() The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
Date	getLastModificationTime() When you create a dataset, LastModificationTime is the same as CreationTime.
Schema	getSchema() An array of SchemaAttribute objects that specify the dataset fields.
String	getStatus() The status of the dataset.
int	hashCode()
void	setCreationTime(Date creationTime) When the dataset was created.
void	setDataFrequency(String dataFrequency) The frequency of data collection.
void	setDatasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset.
void	setDatasetName(String datasetName) The name of the dataset.
void	setDatasetType(String datasetType) The dataset type.
void	setDomain(String domain) The domain associated with the dataset.
void	setEncryptionConfig(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.
void	setLastModificationTime(Date lastModificationTime) When you create a dataset, LastModificationTime is the same as CreationTime.
void	setSchema(Schema schema) An array of SchemaAttribute objects that specify the dataset fields.
void	setStatus(String status) The status of the dataset.
String	toString() Returns a string representation of this object.
DescribeDatasetResult	withCreationTime(Date creationTime) When the dataset was created.
DescribeDatasetResult	withDataFrequency(String dataFrequency) The frequency of data collection.
DescribeDatasetResult	withDatasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset.
DescribeDatasetResult	withDatasetName(String datasetName) The name of the dataset.
DescribeDatasetResult	withDatasetType(DatasetType datasetType) The dataset type.
DescribeDatasetResult	withDatasetType(String datasetType) The dataset type.
DescribeDatasetResult	withDomain(Domain domain) The domain associated with the dataset.
DescribeDatasetResult	withDomain(String domain) The domain associated with the dataset.
DescribeDatasetResult	withEncryptionConfig(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.
DescribeDatasetResult	withLastModificationTime(Date lastModificationTime) When you create a dataset, LastModificationTime is the same as CreationTime.
DescribeDatasetResult	withSchema(Schema schema) An array of SchemaAttribute objects that specify the dataset fields.
DescribeDatasetResult	withStatus(String status) The status of 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

DescribeDatasetResult

public DescribeDatasetResult()

Method Detail

setDatasetArn

public void setDatasetArn(String datasetArn)

The Amazon Resource Name (ARN) of the dataset.

Parameters:

datasetArn - The Amazon Resource Name (ARN) of the dataset.

getDatasetArn

public String getDatasetArn()

The Amazon Resource Name (ARN) of the dataset.

Returns:

The Amazon Resource Name (ARN) of the dataset.

withDatasetArn

public DescribeDatasetResult withDatasetArn(String datasetArn)

The Amazon Resource Name (ARN) of the dataset.

Parameters:

datasetArn - The Amazon Resource Name (ARN) of the dataset.

Returns:

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

setDatasetName

public void setDatasetName(String datasetName)

The name of the dataset.

Parameters:

datasetName - The name of the dataset.

getDatasetName

public String getDatasetName()

The name of the dataset.

Returns:

The name of the dataset.

withDatasetName

public DescribeDatasetResult withDatasetName(String datasetName)

The name of the dataset.

Parameters:

datasetName - The name of the dataset.

Returns:

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

setDomain

public void setDomain(String domain)

The domain associated with the dataset.

Parameters:

domain - The domain associated with the dataset.

See Also:

Domain

getDomain

public String getDomain()

The domain associated with the dataset.

Returns:

The domain associated with the dataset.

See Also:

Domain

withDomain

public DescribeDatasetResult withDomain(String domain)

The domain associated with the dataset.

Parameters:

domain - The domain associated with the dataset.

Returns:

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

See Also:

Domain

withDomain

public DescribeDatasetResult withDomain(Domain domain)

The domain associated with the dataset.

Parameters:

domain - The domain associated with the dataset.

Returns:

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

See Also:

Domain

setDatasetType

public void setDatasetType(String datasetType)

The dataset type.

Parameters:

datasetType - The dataset type.

See Also:

DatasetType

getDatasetType

public String getDatasetType()

The dataset type.

Returns:

The dataset type.

See Also:

DatasetType

withDatasetType

public DescribeDatasetResult withDatasetType(String datasetType)

The dataset type.

Parameters:

datasetType - The dataset type.

Returns:

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

See Also:

DatasetType

withDatasetType

public DescribeDatasetResult withDatasetType(DatasetType datasetType)

The dataset type.

Parameters:

datasetType - The dataset type.

Returns:

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

See Also:

DatasetType

setDataFrequency

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

Parameters:

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.

getDataFrequency

public String getDataFrequency()

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.

Returns:

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.

withDataFrequency

public DescribeDatasetResult withDataFrequency(String 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.

Parameters:

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.

Returns:

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

setSchema

public void setSchema(Schema schema)

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

Parameters:

schema - An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

getSchema

public Schema getSchema()

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

Returns:

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

withSchema

public DescribeDatasetResult withSchema(Schema schema)

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

Parameters:

schema - An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

Returns:

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

setEncryptionConfig

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

Parameters:

encryptionConfig - The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

getEncryptionConfig

public EncryptionConfig getEncryptionConfig()

The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Returns:

The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

withEncryptionConfig

public DescribeDatasetResult withEncryptionConfig(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.

Parameters:

encryptionConfig - The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

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. 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.

Parameters:

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.

getStatus

public String getStatus()

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.

Returns:

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.

withStatus

public DescribeDatasetResult withStatus(String 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.

Parameters:

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.

Returns:

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

setCreationTime

public void setCreationTime(Date creationTime)

When the dataset was created.

Parameters:

creationTime - When the dataset was created.

getCreationTime

public Date getCreationTime()

When the dataset was created.

Returns:

When the dataset was created.

withCreationTime

public DescribeDatasetResult withCreationTime(Date creationTime)

When the dataset was created.

Parameters:

creationTime - When the dataset was created.

Returns:

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

setLastModificationTime

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

Parameters:

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.

getLastModificationTime

public Date getLastModificationTime()

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.

Returns:

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.

withLastModificationTime

public DescribeDatasetResult withLastModificationTime(Date 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.

Parameters:

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.

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 DescribeDatasetResult clone()

Overrides:

clone in class Object