software.amazon.awssdk.services.forecast.model

Class DescribeDatasetResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.forecast.model.ForecastResponse

software.amazon.awssdk.services.forecast.model.DescribeDatasetResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDatasetResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDatasetResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDatasetResponse.Builder	builder()
Instant	creationTime() When the dataset was created.
String	dataFrequency() The frequency of data collection.
String	datasetArn() The Amazon Resource Name (ARN) of the dataset.
String	datasetName() The name of the dataset.
DatasetType	datasetType() The dataset type.
String	datasetTypeAsString() The dataset type.
Domain	domain() The domain associated with the dataset.
String	domainAsString() The domain associated with the dataset.
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime() When you create a dataset, LastModificationTime is the same as CreationTime.
Schema	schema() An array of SchemaAttribute objects that specify the dataset fields.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDatasetResponse.Builder>	serializableBuilderClass()
String	status() The status of the dataset.
DescribeDatasetResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

datasetArn

public final String datasetArn()

The Amazon Resource Name (ARN) of the dataset.

Returns:

The Amazon Resource Name (ARN) of the dataset.

datasetName

public final String datasetName()

The name of the dataset.

Returns:

The name of the dataset.

domain

public final Domain domain()

The domain associated with the dataset.

If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

The domain associated with the dataset.

See Also:

Domain

domainAsString

public final String domainAsString()

The domain associated with the dataset.

If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

The domain associated with the dataset.

See Also:

Domain

datasetType

public final DatasetType datasetType()

The dataset type.

If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

Returns:

The dataset type.

See Also:

DatasetType

datasetTypeAsString

public final String datasetTypeAsString()

The dataset type.

If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

Returns:

The dataset type.

See Also:

DatasetType

dataFrequency

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

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.

schema

public final Schema schema()

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.

encryptionConfig

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

Returns:

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

status

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

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.

creationTime

public final Instant creationTime()

When the dataset was created.

Returns:

When the dataset was created.

lastModificationTime

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

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.

toBuilder

public DescribeDatasetResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDatasetResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDatasetResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo