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>

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public ListBackupsRequest.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<ListBackupsRequest.Builder,ListBackupsRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.