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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,Statistics>	fieldStatistics() Statistical information about each field in the input data.
String	geolocationFormat() The format of the geolocation attribute.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldStatistics() Returns true if the FieldStatistics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Instant	lastModificationTime() The last time that the dataset 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 String datasetImportJobName()

The name of the dataset import job.

Returns:

The name of the dataset import job.

datasetImportJobArn

public String datasetImportJobArn()

The ARN of the dataset import job.

Returns:

The ARN of the dataset import job.

datasetArn

public 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 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 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 Boolean useGeolocationForTimeZone()

Whether TimeZone is automatically derived from the geolocation attribute.

Returns:

Whether TimeZone is automatically derived from the geolocation attribute.

geolocationFormat

public 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 DataSource dataSource()

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

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

Returns:

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

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

hasFieldStatistics

public boolean hasFieldStatistics()

Returns true if the FieldStatistics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

fieldStatistics

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

You can use hasFieldStatistics() to see if a value was sent in this field.

Returns:

Statistical information about each field in the input data.

dataSize

public 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 String status()

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

message

public 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 Instant creationTime()

When the dataset import job was created.

Returns:

When the dataset import job was created.

lastModificationTime

public Instant lastModificationTime()

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

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

Returns:

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time as CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

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

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 int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo