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(value="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 and Description
static interface	DatasetImportJobSummary.Builder

Method Summary

Modifier and Type	Method and 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 AWS 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()
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 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 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 String datasetImportJobName()

The name of the dataset import job.

Returns:

The name of the dataset import job.

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

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

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

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo