software.amazon.awssdk.services.forecast.model

Class DescribeDatasetImportJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,DescribeDatasetImportJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDatasetImportJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDatasetImportJobResponse.Builder	builder()
Instant	creationTime() When the dataset import job was created.
String	datasetArn() The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
String	datasetImportJobArn() The ARN of the dataset import job.
String	datasetImportJobName() The name of the dataset import job.
Double	dataSize() The size of the dataset in gigabytes (GB) after the import job has finished.
DataSource	dataSource() The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeRemainingInMinutes() The estimated time remaining in minutes for the dataset import job to complete.
Map<String,Statistics>	fieldStatistics() Statistical information about each field in the input data.
String	format() The format of the imported data, CSV or PARQUET.
String	geolocationFormat() The format of the geolocation attribute.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldStatistics() For responses, this returns true if the service returned a value for the FieldStatistics property.
int	hashCode()
ImportMode	importMode() The import mode of the dataset import job, FULL or INCREMENTAL.
String	importModeAsString() The import mode of the dataset import job, FULL or INCREMENTAL.
Instant	lastModificationTime() The last time the resource was modified.
String	message() If an error occurred, an informational message about the error.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDatasetImportJobResponse.Builder>	serializableBuilderClass()
String	status() The status of the dataset import job.
String	timestampFormat() The format of timestamps in the dataset.
String	timeZone() The single time zone applied to every item in the dataset
DescribeDatasetImportJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	useGeolocationForTimeZone() Whether TimeZone is automatically derived from the geolocation attribute.

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

datasetImportJobName

public final String datasetImportJobName()

The name of the dataset import job.

Returns:

The name of the dataset import job.

datasetImportJobArn

public final String datasetImportJobArn()

The ARN of the dataset import job.

Returns:

The ARN of the dataset import job.

datasetArn

public final String datasetArn()

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Returns:

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

timestampFormat

public final String timestampFormat()

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

• "yyyy-MM-dd"

  For the following data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

Returns:

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

• "yyyy-MM-dd"

  For the following data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

timeZone

public final String timeZone()

The single time zone applied to every item in the dataset

Returns:

The single time zone applied to every item in the dataset

useGeolocationForTimeZone

public final Boolean useGeolocationForTimeZone()

Whether TimeZone is automatically derived from the geolocation attribute.

Returns:

Whether TimeZone is automatically derived from the geolocation attribute.

geolocationFormat

public final String geolocationFormat()

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

Returns:

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

dataSource

public final DataSource dataSource()

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an Key Management Service (KMS) key.

Returns:

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an Key Management Service (KMS) key.

estimatedTimeRemainingInMinutes

public final Long estimatedTimeRemainingInMinutes()

The estimated time remaining in minutes for the dataset import job to complete.

Returns:

The estimated time remaining in minutes for the dataset import job to complete.

hasFieldStatistics

public final boolean hasFieldStatistics()

For responses, this returns true if the service returned a value for the FieldStatistics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fieldStatistics

public final Map<String,Statistics> fieldStatistics()

Statistical information about each field in the input data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldStatistics() method.

Returns:

Statistical information about each field in the input data.

dataSize

public final Double dataSize()

The size of the dataset in gigabytes (GB) after the import job has finished.

Returns:

The size of the dataset in gigabytes (GB) after the import job has finished.

status

public final String status()

The status of the dataset import job. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

Returns:

The status of the dataset import job. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

message

public final String message()

If an error occurred, an informational message about the error.

Returns:

If an error occurred, an informational message about the error.

creationTime

public final Instant creationTime()

When the dataset import job was created.

Returns:

When the dataset import job was created.

lastModificationTime

public final Instant lastModificationTime()

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

format

public final String format()

The format of the imported data, CSV or PARQUET.

Returns:

The format of the imported data, CSV or PARQUET.

importMode

public final ImportMode importMode()

The import mode of the dataset import job, FULL or INCREMENTAL.

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

Returns:

The import mode of the dataset import job, FULL or INCREMENTAL.

See Also:

ImportMode

importModeAsString

public final String importModeAsString()

The import mode of the dataset import job, FULL or INCREMENTAL.

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

Returns:

The import mode of the dataset import job, FULL or INCREMENTAL.

See Also:

ImportMode

toBuilder

public DescribeDatasetImportJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,DescribeDatasetImportJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDatasetImportJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDatasetImportJobResponse.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