Interface DescribeDatasetResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeDatasetResponse.Builder,
,DescribeDatasetResponse> ForecastResponse.Builder
,SdkBuilder<DescribeDatasetResponse.Builder,
,DescribeDatasetResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeDatasetResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) When the dataset was created.dataFrequency
(String dataFrequency) The frequency of data collection.datasetArn
(String datasetArn) The Amazon Resource Name (ARN) of the dataset.datasetName
(String datasetName) The name of the dataset.datasetType
(String datasetType) The dataset type.datasetType
(DatasetType datasetType) The dataset type.The domain associated with the dataset.The domain associated with the dataset.default DescribeDatasetResponse.Builder
encryptionConfig
(Consumer<EncryptionConfig.Builder> encryptionConfig) The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.encryptionConfig
(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.lastModificationTime
(Instant lastModificationTime) When you create a dataset,LastModificationTime
is the same asCreationTime
.default DescribeDatasetResponse.Builder
schema
(Consumer<Schema.Builder> schema) An array ofSchemaAttribute
objects that specify the dataset fields.An array ofSchemaAttribute
objects that specify the dataset fields.The status of the dataset.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
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
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:
-
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
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:
-
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.
-
schema
An array of
SchemaAttribute
objects that specify the dataset fields. EachSchemaAttribute
specifies the name and data type of a field.- Parameters:
schema
- An array ofSchemaAttribute
objects that specify the dataset fields. EachSchemaAttribute
specifies the name and data type of a field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schema
An array of
This is a convenience method that creates an instance of theSchemaAttribute
objects that specify the dataset fields. EachSchemaAttribute
specifies the name and data type of a field.Schema.Builder
avoiding the need to create one manually viaSchema.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschema(Schema)
.- Parameters:
schema
- a consumer that will call methods onSchema.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
encryptionConfig
default DescribeDatasetResponse.Builder encryptionConfig(Consumer<EncryptionConfig.Builder> encryptionConfig) The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
This is a convenience method that creates an instance of theEncryptionConfig.Builder
avoiding the need to create one manually viaEncryptionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfig(EncryptionConfig)
.- Parameters:
encryptionConfig
- a consumer that will call methods onEncryptionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isCREATE_IN_PROGRESS
, the status of the dataset isUPDATE_IN_PROGRESS
.The
Status
of the dataset must beACTIVE
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 isCREATE_IN_PROGRESS
, the status of the dataset isUPDATE_IN_PROGRESS
.The
Status
of the dataset must beACTIVE
before you can import training data.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
-
lastModificationTime
When you create a dataset,
LastModificationTime
is the same asCreationTime
. While data is being imported to the dataset,LastModificationTime
is the current time of theDescribeDataset
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 asCreationTime
. While data is being imported to the dataset,LastModificationTime
is the current time of theDescribeDataset
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.
-