com.amazonaws.services.forecast.model

Class CreateDatasetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.forecast.model.CreateDatasetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDatasetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDatasetRequest()

Method Summary

Modifier and Type	Method and Description
CreateDatasetRequest	clone()
boolean	equals(Object obj)
String	getDataFrequency() The frequency of data collection.
String	getDatasetName() A name for the dataset.
String	getDatasetType() The dataset type.
String	getDomain() The domain associated with the dataset.
EncryptionConfig	getEncryptionConfig() An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
Schema	getSchema() The schema for the dataset.
int	hashCode()
void	setDataFrequency(String dataFrequency) The frequency of data collection.
void	setDatasetName(String datasetName) A name for the dataset.
void	setDatasetType(String datasetType) The dataset type.
void	setDomain(String domain) The domain associated with the dataset.
void	setEncryptionConfig(EncryptionConfig encryptionConfig) An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
void	setSchema(Schema schema) The schema for the dataset.
String	toString() Returns a string representation of this object.
CreateDatasetRequest	withDataFrequency(String dataFrequency) The frequency of data collection.
CreateDatasetRequest	withDatasetName(String datasetName) A name for the dataset.
CreateDatasetRequest	withDatasetType(DatasetType datasetType) The dataset type.
CreateDatasetRequest	withDatasetType(String datasetType) The dataset type.
CreateDatasetRequest	withDomain(Domain domain) The domain associated with the dataset.
CreateDatasetRequest	withDomain(String domain) The domain associated with the dataset.
CreateDatasetRequest	withEncryptionConfig(EncryptionConfig encryptionConfig) An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
CreateDatasetRequest	withSchema(Schema schema) The schema for the dataset.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDatasetRequest

public CreateDatasetRequest()

Method Detail

setDatasetName

public void setDatasetName(String datasetName)

A name for the dataset.

Parameters:

datasetName - A name for the dataset.

getDatasetName

public String getDatasetName()

A name for the dataset.

Returns:

A name for the dataset.

withDatasetName

public CreateDatasetRequest withDatasetName(String datasetName)

A name for the dataset.

Parameters:

datasetName - A name for 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. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Parameters:

domain - The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

See Also:

Domain

getDomain

public String getDomain()

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Returns:

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

See Also:

Domain

withDomain

public CreateDatasetRequest withDomain(String domain)

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Parameters:

domain - The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Returns:

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

See Also:

Domain

withDomain

public CreateDatasetRequest withDomain(Domain domain)

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Parameters:

domain - The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

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. Valid values depend on the chosen Domain.

Parameters:

datasetType - The dataset type. Valid values depend on the chosen Domain.

See Also:

DatasetType

getDatasetType

public String getDatasetType()

The dataset type. Valid values depend on the chosen Domain.

Returns:

The dataset type. Valid values depend on the chosen Domain.

See Also:

DatasetType

withDatasetType

public CreateDatasetRequest withDatasetType(String datasetType)

The dataset type. Valid values depend on the chosen Domain.

Parameters:

datasetType - The dataset type. Valid values depend on the chosen Domain.

Returns:

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

See Also:

DatasetType

withDatasetType

public CreateDatasetRequest withDatasetType(DatasetType datasetType)

The dataset type. Valid values depend on the chosen Domain.

Parameters:

datasetType - The dataset type. Valid values depend on the chosen Domain.

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. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

Parameters:

dataFrequency - The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

getDataFrequency

public String getDataFrequency()

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

Returns:

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

withDataFrequency

public CreateDatasetRequest withDataFrequency(String dataFrequency)

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

Parameters:

dataFrequency - The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

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, "D" indicates every day and "15min" indicates every 15 minutes.

Returns:

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

setSchema

public void setSchema(Schema schema)

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Parameters:

schema - The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

getSchema

public Schema getSchema()

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Returns:

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

withSchema

public CreateDatasetRequest withSchema(Schema schema)

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Parameters:

schema - The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Returns:

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

setEncryptionConfig

public void setEncryptionConfig(EncryptionConfig encryptionConfig)

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

Parameters:

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

getEncryptionConfig

public EncryptionConfig getEncryptionConfig()

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

Returns:

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

withEncryptionConfig

public CreateDatasetRequest withEncryptionConfig(EncryptionConfig encryptionConfig)

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

Parameters:

encryptionConfig - An AWS Key Management Service (KMS) key and the AWS 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.

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

Overrides:

clone in class AmazonWebServiceRequest