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 import job can be in one of the following states:

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

See Also:

  • Method Details

    • 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 import job.

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

      • CREATE PENDING > CREATE IN_PROGRESS > 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<DatasetImportJob.Builder,DatasetImportJob>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.