Package software.amazon.awssdk.services.personalize.model

Class DatasetImportJob

java.lang.Object

software.amazon.awssdk.services.personalize.model.DatasetImportJob

All Implemented Interfaces:

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

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

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset ACTIVE -or- CREATE FAILED

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetImportJob.Builder

Method Summary

Modifier and Type	Method	Description
static DatasetImportJob.Builder	builder()
Instant	creationDateTime()	The creation date and time (in Unix time) of the dataset import job.
String	datasetArn()	The Amazon Resource Name (ARN) of the dataset that receives the imported data.
String	datasetImportJobArn()	The ARN of the dataset import job.
DataSource	dataSource()	The Amazon S3 bucket that contains the training data to import.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	If a dataset import job fails, provides the reason why.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ImportMode	importMode()	The import mode used by the dataset import job to import new records.
String	importModeAsString()	The import mode used by the dataset import job to import new records.
String	jobName()	The name of the import job.
Instant	lastUpdatedDateTime()	The date and time (in Unix time) the dataset was last updated.
Boolean	publishAttributionMetricsToS3()	Whether the job publishes metrics to Amazon S3 for a metric attribution.
String	roleArn()	The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DatasetImportJob.Builder>	serializableBuilderClass()
String	status()	The status of the dataset ACTIVE -or- CREATE FAILED
DatasetImportJob.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

jobName

public final String jobName()

The name of the import job.

Returns:

The name of the 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 receives the imported data.

Returns:

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

dataSource

public final DataSource dataSource()

The Amazon S3 bucket that contains the training data to import.

Returns:

The Amazon S3 bucket that contains the training data to import.

roleArn

public final String roleArn()

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

Returns:

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

status

public final String status()

The status of the dataset ACTIVE -or- CREATE FAILED

Returns:

The status of the dataset import job.

A dataset import job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

creationDateTime

public final Instant creationDateTime()

The creation date and time (in Unix time) of the dataset import job.

Returns:

The creation date and time (in Unix time) of the dataset import job.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The date and time (in Unix time) the dataset was last updated.

Returns:

The date and time (in Unix time) the dataset was last updated.

failureReason

public final String failureReason()

If a dataset import job fails, provides the reason why.

Returns:

If a dataset import job fails, provides the reason why.

importMode

public final ImportMode importMode()

The import mode used by the dataset import job to import new records.

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 used by the dataset import job to import new records.

See Also:

ImportMode

importModeAsString

public final String importModeAsString()

The import mode used by the dataset import job to import new records.

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 used by the dataset import job to import new records.

See Also:

ImportMode

publishAttributionMetricsToS3

public final Boolean publishAttributionMetricsToS3()

Whether the job publishes metrics to Amazon S3 for a metric attribution.

Returns:

Whether the job publishes metrics to Amazon S3 for a metric attribution.

toBuilder

public DatasetImportJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetImportJob.Builder,DatasetImportJob>

builder

public static DatasetImportJob.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo