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

Class ListBackupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest

software.amazon.awssdk.services.dynamodb.model.ListBackupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBackupsRequest.Builder,ListBackupsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListBackupsRequest
extends DynamoDbRequest
implements ToCopyableBuilder<ListBackupsRequest.Builder,ListBackupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBackupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
BackupTypeFilter	backupType()	The backups from the table specified by BackupType are listed.
String	backupTypeAsString()	The backups from the table specified by BackupType are listed.
static ListBackupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exclusiveStartBackupArn()	LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	Maximum number of backups to return at once.
List<SdkField<?>>	sdkFields()
static Class<? extends ListBackupsRequest.Builder>	serializableBuilderClass()
String	tableName()	Lists the backups from the table specified in TableName.
Instant	timeRangeLowerBound()	Only backups created after this time are listed.
Instant	timeRangeUpperBound()	Only backups created before this time are listed.
ListBackupsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

limit

public final Integer limit()

Maximum number of backups to return at once.

Returns:

Maximum number of backups to return at once.

timeRangeLowerBound

public final Instant timeRangeLowerBound()

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

Returns:

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

timeRangeUpperBound

public final Instant timeRangeUpperBound()

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

Returns:

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

exclusiveStartBackupArn

public final String exclusiveStartBackupArn()

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

Returns:

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

backupType

public final BackupTypeFilter backupType()

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

• SYSTEM - On-demand backup automatically created by DynamoDB.

• ALL - All types of on-demand backups (USER and SYSTEM).

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

Returns:

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

• SYSTEM - On-demand backup automatically created by DynamoDB.

• ALL - All types of on-demand backups (USER and SYSTEM).

See Also:

BackupTypeFilter

backupTypeAsString

public final String backupTypeAsString()

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

• SYSTEM - On-demand backup automatically created by DynamoDB.

• ALL - All types of on-demand backups (USER and SYSTEM).

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

Returns:

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

• SYSTEM - On-demand backup automatically created by DynamoDB.

• ALL - All types of on-demand backups (USER and SYSTEM).

See Also:

BackupTypeFilter

toBuilder

public ListBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBackupsRequest.Builder,ListBackupsRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static ListBackupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListBackupsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo