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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BackupSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	backupArn()	ARN associated with the backup.
Instant	backupCreationDateTime()	Time at which the backup was created.
Instant	backupExpiryDateTime()	Time at which the automatic on-demand backup created by DynamoDB will expire.
String	backupName()	Name of the specified backup.
Long	backupSizeBytes()	Size of the backup in bytes.
BackupStatus	backupStatus()	Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
String	backupStatusAsString()	Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
BackupType	backupType()	BackupType:
String	backupTypeAsString()	BackupType:
static BackupSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends BackupSummary.Builder>	serializableBuilderClass()
String	tableArn()	ARN associated with the table.
String	tableId()	Unique identifier for the table.
String	tableName()	Name of the table.
BackupSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

BackupStatus

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:

BackupStatus

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:

BackupType

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:

BackupType

backupSizeBytes

public final Long backupSizeBytes()

Size of the backup in bytes.

Returns:

Size of the backup in bytes.

toBuilder

public BackupSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BackupSummary.Builder,BackupSummary>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo