software.amazon.awssdk.services.forecast.model

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

Modifier and Type	Method and Description
DescribeDatasetResponse.Builder	creationTime(Instant creationTime) When the dataset was created.
DescribeDatasetResponse.Builder	dataFrequency(String dataFrequency) The frequency of data collection.
DescribeDatasetResponse.Builder	datasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset.
DescribeDatasetResponse.Builder	datasetName(String datasetName) The name of the dataset.
DescribeDatasetResponse.Builder	datasetType(DatasetType datasetType) The dataset type.
DescribeDatasetResponse.Builder	datasetType(String datasetType) The dataset type.
DescribeDatasetResponse.Builder	domain(Domain domain) The domain associated with the dataset.
DescribeDatasetResponse.Builder	domain(String domain) The domain associated with the dataset.
default DescribeDatasetResponse.Builder	encryptionConfig(Consumer<EncryptionConfig.Builder> encryptionConfig) The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
DescribeDatasetResponse.Builder	encryptionConfig(EncryptionConfig encryptionConfig) The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
DescribeDatasetResponse.Builder	lastModificationTime(Instant lastModificationTime) When you create a dataset, LastModificationTime is the same as CreationTime.
default DescribeDatasetResponse.Builder	schema(Consumer<Schema.Builder> schema) An array of SchemaAttribute objects that specify the dataset fields.
DescribeDatasetResponse.Builder	schema(Schema schema) An array of SchemaAttribute objects that specify the dataset fields.
DescribeDatasetResponse.Builder	status(String status) The status of the dataset.

Methods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

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, Domain

domain

DescribeDatasetResponse.Builder domain(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, Domain

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

schema

default DescribeDatasetResponse.Builder schema(Consumer<Schema.Builder> schema)

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

This is a convenience that creates an instance of the Schema.Builder avoiding the need to create one manually via Schema.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schema(Schema).

Parameters:

schema - a consumer that will call methods on Schema.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 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 - The 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.

encryptionConfig

default DescribeDatasetResponse.Builder encryptionConfig(Consumer<EncryptionConfig.Builder> encryptionConfig)

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

This is a convenience that creates an instance of the EncryptionConfig.Builder avoiding the need to create one manually via EncryptionConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfig(EncryptionConfig).

Parameters:

encryptionConfig - a consumer that will call methods on EncryptionConfig.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 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.

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