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

Class DataDeletionJob

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

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      The name of the data deletion job.

      Returns:
      The name of the data deletion job.

    • dataDeletionJobArn

      public final String dataDeletionJobArn()

      The Amazon Resource Name (ARN) of the data deletion job.

      Returns:
      The Amazon Resource Name (ARN) of the data deletion job.

    • datasetGroupArn

      public final String datasetGroupArn()

      The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

      Returns:
      The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

    • dataSource

      public final DataSource dataSource()
      Returns the value of the DataSource property for this object.
      Returns:
      The value of the DataSource property for this object.

    • roleArn

      public final String roleArn()

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

      Returns:
      The Amazon Resource Name (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 data deletion job.

      A data deletion job can have one of the following statuses:

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

      Returns:
      The status of the data deletion job.

      A data deletion job can have one of the following statuses:

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

    • numDeleted

      public final Integer numDeleted()

      The number of records deleted by a COMPLETED job.

      Returns:
      The number of records deleted by a COMPLETED job.

    • creationDateTime

      public final Instant creationDateTime()

      The creation date and time (in Unix time) of the data deletion job.

      Returns:
      The creation date and time (in Unix time) of the data deletion job.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time (in Unix time) the data deletion job was last updated.

      Returns:
      The date and time (in Unix time) the data deletion job was last updated.

    • failureReason

      public final String failureReason()

      If a data deletion job fails, provides the reason why.

      Returns:
      If a data deletion job fails, provides the reason why.

    • toBuilder

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

    • builder

      public static DataDeletionJob.Builder builder()

    • serializableBuilderClass

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