Package software.amazon.awssdk.services.forecast.model

Class DatasetImportJobSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.DatasetImportJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DatasetImportJobSummary.Builder,DatasetImportJobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class DatasetImportJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DatasetImportJobSummary.Builder,DatasetImportJobSummary>

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the DatasetImportJobArn.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetImportJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
static DatasetImportJobSummary.Builder	builder()
Instant	creationTime()	When the dataset import job was created.
String	datasetImportJobArn()	The Amazon Resource Name (ARN) of the dataset import job.
String	datasetImportJobName()	The name of the dataset import job.
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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 DatasetImportJobSummary.Builder>	serializableBuilderClass()
String	status()	The status of the dataset import job.
DatasetImportJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

datasetImportJobArn

public final String datasetImportJobArn()

The Amazon Resource Name (ARN) of the dataset import job.

Returns:

The Amazon Resource Name (ARN) of the dataset import job.

datasetImportJobName

public final String datasetImportJobName()

The name of the dataset import job.

Returns:

The name of the dataset import job.

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. The training data must be stored in an Amazon S3 bucket.

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. The training data must be stored in an Amazon S3 bucket.

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

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.

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 DatasetImportJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetImportJobSummary.Builder,DatasetImportJobSummary>

builder

public static DatasetImportJobSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo