Package software.amazon.awssdk.services.dynamodb.model

Class BackupSummary

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

Contains details for the backup.

See Also:

  • Method Details

    • tableName

      public final String tableName()

      Name of the table.

      Returns:
      Name of the table.

    • tableId

      public final String tableId()

      Unique identifier for the table.

      Returns:
      Unique identifier for the table.

    • tableArn

      public final String tableArn()

      ARN associated with the table.

      Returns:
      ARN associated with the table.

    • backupArn

      public final String backupArn()

      ARN associated with the backup.

      Returns:
      ARN associated with the backup.

    • backupName

      public final String backupName()

      Name of the specified backup.

      Returns:
      Name of the specified backup.

    • backupCreationDateTime

      public final Instant backupCreationDateTime()

      Time at which the backup was created.

      Returns:
      Time at which the backup was created.

    • backupExpiryDateTime

      public final Instant backupExpiryDateTime()

      Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

      Returns:
      Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

    • backupStatus

      public final BackupStatus backupStatus()

      Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

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

      Returns:
      Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
      See Also:

    • backupStatusAsString

      public final String backupStatusAsString()

      Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

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

      Returns:
      Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
      See Also:

    • backupType

      public final BackupType backupType()

      BackupType:

      • USER - You create and manage these using the on-demand backup feature.

      • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

      • AWS_BACKUP - On-demand backup created by you from Backup service.

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

      Returns:
      BackupType:

      • USER - You create and manage these using the on-demand backup feature.

      • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

      • AWS_BACKUP - On-demand backup created by you from Backup service.

      See Also:

    • backupTypeAsString

      public final String backupTypeAsString()

      BackupType:

      • USER - You create and manage these using the on-demand backup feature.

      • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

      • AWS_BACKUP - On-demand backup created by you from Backup service.

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

      Returns:
      BackupType:

      • USER - You create and manage these using the on-demand backup feature.

      • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

      • AWS_BACKUP - On-demand backup created by you from Backup service.

      See Also:

    • backupSizeBytes

      public final Long backupSizeBytes()

      Size of the backup in bytes.

      Returns:
      Size of the backup in bytes.

    • toBuilder

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

    • builder

      public static BackupSummary.Builder builder()

    • serializableBuilderClass

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