Interface DescribeDatasetResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>,ForecastResponse.Builder,SdkBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeDatasetResponse
public static interface DescribeDatasetResponse.Builder extends ForecastResponse.Builder, SdkPojo, CopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeDatasetResponse.BuildercreationTime(Instant creationTime)When the dataset was created.DescribeDatasetResponse.BuilderdataFrequency(String dataFrequency)The frequency of data collection.DescribeDatasetResponse.BuilderdatasetArn(String datasetArn)The Amazon Resource Name (ARN) of the dataset.DescribeDatasetResponse.BuilderdatasetName(String datasetName)The name of the dataset.DescribeDatasetResponse.BuilderdatasetType(String datasetType)The dataset type.DescribeDatasetResponse.BuilderdatasetType(DatasetType datasetType)The dataset type.DescribeDatasetResponse.Builderdomain(String domain)The domain associated with the dataset.DescribeDatasetResponse.Builderdomain(Domain domain)The domain associated with the dataset.default DescribeDatasetResponse.BuilderencryptionConfig(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.DescribeDatasetResponse.BuilderencryptionConfig(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.DescribeDatasetResponse.BuilderlastModificationTime(Instant lastModificationTime)When you create a dataset,LastModificationTimeis the same asCreationTime.default DescribeDatasetResponse.Builderschema(Consumer<Schema.Builder> schema)An array ofSchemaAttributeobjects that specify the dataset fields.DescribeDatasetResponse.Builderschema(Schema schema)An array ofSchemaAttributeobjects that specify the dataset fields.DescribeDatasetResponse.Builderstatus(String status)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, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
datasetArn
DescribeDatasetResponse.Builder datasetArn(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.
-
datasetName
DescribeDatasetResponse.Builder datasetName(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.
-
domain
DescribeDatasetResponse.Builder domain(String domain)
The domain associated with the dataset.
-
domain
DescribeDatasetResponse.Builder domain(Domain domain)
The domain associated with the dataset.
-
datasetType
DescribeDatasetResponse.Builder datasetType(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,DatasetType
-
datasetType
DescribeDatasetResponse.Builder datasetType(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,DatasetType
-
dataFrequency
DescribeDatasetResponse.Builder dataFrequency(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.
-
schema
DescribeDatasetResponse.Builder schema(Schema schema)
An array of
SchemaAttributeobjects that specify the dataset fields. EachSchemaAttributespecifies the name and data type of a field.- Parameters:
schema- An array ofSchemaAttributeobjects that specify the dataset fields. EachSchemaAttributespecifies the name and data type of a field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schema
default DescribeDatasetResponse.Builder schema(Consumer<Schema.Builder> schema)
An array of
This is a convenience method that creates an instance of theSchemaAttributeobjects that specify the dataset fields. EachSchemaAttributespecifies the name and data type of a field.Schema.Builderavoiding the need to create one manually viaSchema.builder().When the
Consumercompletes,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:
schema(Schema)
-
encryptionConfig
DescribeDatasetResponse.Builder 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.
- 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.Builderavoiding the need to create one manually viaEncryptionConfig.builder().When the
Consumercompletes,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:
encryptionConfig(EncryptionConfig)
-
status
DescribeDatasetResponse.Builder status(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
UPDATEstates 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
Statusof the dataset must beACTIVEbefore 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
UPDATEstates 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
Statusof the dataset must beACTIVEbefore you can import training data.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
creationTime
DescribeDatasetResponse.Builder creationTime(Instant 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
DescribeDatasetResponse.Builder lastModificationTime(Instant lastModificationTime)
When you create a dataset,
LastModificationTimeis the same asCreationTime. While data is being imported to the dataset,LastModificationTimeis the current time of theDescribeDatasetcall. After a CreateDatasetImportJob operation has finished,LastModificationTimeis when the import job completed or failed.- Parameters:
lastModificationTime- When you create a dataset,LastModificationTimeis the same asCreationTime. While data is being imported to the dataset,LastModificationTimeis the current time of theDescribeDatasetcall. After a CreateDatasetImportJob operation has finished,LastModificationTimeis when the import job completed or failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-