Class DatasetExportJob

java.lang.Object
software.amazon.awssdk.services.personalize.model.DatasetExportJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetExportJob.Builder,DatasetExportJob>
@Generated("software.amazon.awssdk:codegen") public final class DatasetExportJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetExportJob.Builder,DatasetExportJob>

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

A dataset export 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 export job.

      Returns:
      The name of the export job.

    • datasetExportJobArn

      public final String datasetExportJobArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the dataset export job.

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset to export.

      Returns:
      The Amazon Resource Name (ARN) of the dataset to export.

    • ingestionMode

      public final IngestionMode ingestionMode()

      The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

      If the service returns an enum value that is not available in the current SDK version, ingestionMode will return IngestionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ingestionModeAsString().

      Returns:
      The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
      See Also:

    • ingestionModeAsString

      public final String ingestionModeAsString()

      The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

      If the service returns an enum value that is not available in the current SDK version, ingestionMode will return IngestionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ingestionModeAsString().

      Returns:
      The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

      Returns:
      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

    • status

      public final String status()

      The status of the dataset export job.

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

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

      Returns:
      The status of the dataset export job.

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

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

    • jobOutput

      public final DatasetExportJobOutput jobOutput()

      The path to the Amazon S3 bucket where the job's output is stored. For example:

      s3://bucket-name/folder-name/

      Returns:
      The path to the Amazon S3 bucket where the job's output is stored. For example:

      s3://bucket-name/folder-name/

    • creationDateTime

      public final Instant creationDateTime()

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

      Returns:
      The creation date and time (in Unix time) of the dataset export job.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time (in Unix time) the status of the dataset export job was last updated.

      Returns:
      The date and time (in Unix time) the status of the dataset export job was last updated.

    • failureReason

      public final String failureReason()

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

      Returns:
      If a dataset export job fails, provides the reason why.

    • toBuilder

      public DatasetExportJob.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<DatasetExportJob.Builder,DatasetExportJob>
      Returns:
      a builder for type T

    • builder

      public static DatasetExportJob.Builder builder()

    • serializableBuilderClass

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