Class DatasetImportJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DatasetImportJob.Builder
builder()
final Instant
The creation date and time (in Unix time) of the dataset import job.final String
The Amazon Resource Name (ARN) of the dataset that receives the imported data.final String
The ARN of the dataset import job.final DataSource
The Amazon S3 bucket that contains the training data to import.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If a dataset import job fails, provides the reason why.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final ImportMode
The import mode used by the dataset import job to import new records.final String
The import mode used by the dataset import job to import new records.final String
jobName()
The name of the import job.final Instant
The date and time (in Unix time) the dataset was last updated.final Boolean
Whether the job publishes metrics to Amazon S3 for a metric attribution.final String
roleArn()
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.static Class
<? extends DatasetImportJob.Builder> final String
status()
The status of the dataset ACTIVE -or- CREATE FAILEDTake this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobName
The name of the import job.
- Returns:
- The name of the import job.
-
datasetImportJobArn
The ARN of the dataset import job.
- Returns:
- The ARN of the dataset import job.
-
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
The Amazon S3 bucket that contains the training data to import.
- Returns:
- The Amazon S3 bucket that contains the training data to import.
-
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
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
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
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
If a dataset import job fails, provides the reason why.
- Returns:
- If a dataset import job fails, provides the reason why.
-
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 returnImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- The import mode used by the dataset import job to import new records.
- See Also:
-
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 returnImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- The import mode used by the dataset import job to import new records.
- See Also:
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DatasetImportJob.Builder,
DatasetImportJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-