ListBackupsRequest (aws-android-sdk-ddb 2.68.0 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dynamodbv2.model.ListBackupsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListBackupsRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call ListBackups a maximum of 5 times per second.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListBackupsRequest()

Constructors
Constructor and Description
`ListBackupsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBackupType()` The backups from the table specified by `BackupType` are listed.
`java.lang.String`	`getExclusiveStartBackupArn()` `LastEvaluatedBackupArn` is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results.
`java.lang.Integer`	`getLimit()` Maximum number of backups to return at once.
`java.lang.String`	`getTableName()` The backups from the table specified by `TableName` are listed.
`java.util.Date`	`getTimeRangeLowerBound()` Only backups created after this time are listed.
`java.util.Date`	`getTimeRangeUpperBound()` Only backups created before this time are listed.
`int`	`hashCode()`
`void`	`setBackupType(BackupTypeFilter backupType)` The backups from the table specified by `BackupType` are listed.
`void`	`setBackupType(java.lang.String backupType)` The backups from the table specified by `BackupType` are listed.
`void`	`setExclusiveStartBackupArn(java.lang.String exclusiveStartBackupArn)` `LastEvaluatedBackupArn` is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results.
`void`	`setLimit(java.lang.Integer limit)` Maximum number of backups to return at once.
`void`	`setTableName(java.lang.String tableName)` The backups from the table specified by `TableName` are listed.
`void`	`setTimeRangeLowerBound(java.util.Date timeRangeLowerBound)` Only backups created after this time are listed.
`void`	`setTimeRangeUpperBound(java.util.Date timeRangeUpperBound)` Only backups created before this time are listed.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListBackupsRequest`	`withBackupType(BackupTypeFilter backupType)` The backups from the table specified by `BackupType` are listed.
`ListBackupsRequest`	`withBackupType(java.lang.String backupType)` The backups from the table specified by `BackupType` are listed.
`ListBackupsRequest`	`withExclusiveStartBackupArn(java.lang.String exclusiveStartBackupArn)` `LastEvaluatedBackupArn` is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results.
`ListBackupsRequest`	`withLimit(java.lang.Integer limit)` Maximum number of backups to return at once.
`ListBackupsRequest`	`withTableName(java.lang.String tableName)` The backups from the table specified by `TableName` are listed.
`ListBackupsRequest`	`withTimeRangeLowerBound(java.util.Date timeRangeLowerBound)` Only backups created after this time are listed.
`ListBackupsRequest`	`withTimeRangeUpperBound(java.util.Date timeRangeUpperBound)` Only backups created before this time are listed.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListBackupsRequest
```
public ListBackupsRequest()
```
- Method Detail
  - getTableName
```
public java.lang.String getTableName()
```
    The backups from the table specified by TableName are listed.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The backups from the table specified by TableName are listed.
  - setTableName
```
public void setTableName(java.lang.String tableName)
```
    The backups from the table specified by TableName are listed.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    tableName -
    The backups from the table specified by TableName are listed.
  - withTableName
```
public ListBackupsRequest withTableName(java.lang.String tableName)
```
    The backups from the table specified by TableName are listed.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    tableName -
    The backups from the table specified by TableName are listed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public java.lang.Integer getLimit()
```
    Maximum number of backups to return at once.
    
    Constraints:
    Range: 1 - 100
    
    Returns:
    
    Maximum number of backups to return at once.
  - setLimit
```
public void setLimit(java.lang.Integer limit)
```
    Maximum number of backups to return at once.
    
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    limit -
    Maximum number of backups to return at once.
  - withLimit
```
public ListBackupsRequest withLimit(java.lang.Integer limit)
```
    Maximum number of backups to return at once.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    limit -
    Maximum number of backups to return at once.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimeRangeLowerBound
```
public java.util.Date getTimeRangeLowerBound()
```
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
    
    Returns:
    
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
  - setTimeRangeLowerBound
```
public void setTimeRangeLowerBound(java.util.Date timeRangeLowerBound)
```
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
    
    Parameters:
    
    timeRangeLowerBound -
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
  - withTimeRangeLowerBound
```
public ListBackupsRequest withTimeRangeLowerBound(java.util.Date timeRangeLowerBound)
```
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    timeRangeLowerBound -
    Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimeRangeUpperBound
```
public java.util.Date getTimeRangeUpperBound()
```
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
    
    Returns:
    
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
  - setTimeRangeUpperBound
```
public void setTimeRangeUpperBound(java.util.Date timeRangeUpperBound)
```
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
    
    Parameters:
    
    timeRangeUpperBound -
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
  - withTimeRangeUpperBound
```
public ListBackupsRequest withTimeRangeUpperBound(java.util.Date timeRangeUpperBound)
```
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    timeRangeUpperBound -
    Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExclusiveStartBackupArn
```
public java.lang.String getExclusiveStartBackupArn()
```
    LastEvaluatedBackupArn is the 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.
    
    Constraints:
    Length: 37 - 1024
    
    Returns:
    
    LastEvaluatedBackupArn is the 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.
  - setExclusiveStartBackupArn
```
public void setExclusiveStartBackupArn(java.lang.String exclusiveStartBackupArn)
```
    LastEvaluatedBackupArn is the 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.
    
    Constraints:
    Length: 37 - 1024
    
    Parameters:
    
    exclusiveStartBackupArn -
    LastEvaluatedBackupArn is the 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.
  - withExclusiveStartBackupArn
```
public ListBackupsRequest withExclusiveStartBackupArn(java.lang.String exclusiveStartBackupArn)
```
    LastEvaluatedBackupArn is the 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 37 - 1024
    
    Parameters:
    
    exclusiveStartBackupArn -
    LastEvaluatedBackupArn is the 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getBackupType
```
public java.lang.String getBackupType()
```
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    - USER - On-demand backup created by you.
    - SYSTEM - On-demand backup automatically created by DynamoDB.
    - ALL - All types of on-demand backups (USER and SYSTEM).
    Constraints:
    Allowed Values: USER, SYSTEM, ALL
    Returns:
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    
    USER - On-demand backup created by you.
    
    SYSTEM - On-demand backup automatically created by DynamoDB.
    
    ALL - All types of on-demand backups (USER and SYSTEM).
    See Also:
    
    BackupTypeFilter
  - setBackupType
```
public void setBackupType(java.lang.String backupType)
```
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    - USER - On-demand backup created by you.
    - SYSTEM - On-demand backup automatically created by DynamoDB.
    - ALL - All types of on-demand backups (USER and SYSTEM).
    Constraints:
    Allowed Values: USER, SYSTEM, ALL
    Parameters:
    backupType -
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    
    USER - On-demand backup created by you.
    
    SYSTEM - On-demand backup automatically created by DynamoDB.
    
    ALL - All types of on-demand backups (USER and SYSTEM).
    See Also:
    
    BackupTypeFilter
  - withBackupType
```
public ListBackupsRequest withBackupType(java.lang.String backupType)
```
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    - USER - On-demand backup created by you.
    - SYSTEM - On-demand backup automatically created by DynamoDB.
    - ALL - All types of on-demand backups (USER and SYSTEM).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: USER, SYSTEM, ALL
    Parameters:
    backupType -
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    
    USER - On-demand backup created by you.
    
    SYSTEM - On-demand backup automatically created by DynamoDB.
    
    ALL - All types of on-demand backups (USER and SYSTEM).
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    BackupTypeFilter
  - setBackupType
```
public void setBackupType(BackupTypeFilter backupType)
```
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    - USER - On-demand backup created by you.
    - SYSTEM - On-demand backup automatically created by DynamoDB.
    - ALL - All types of on-demand backups (USER and SYSTEM).
    Constraints:
    Allowed Values: USER, SYSTEM, ALL
    Parameters:
    backupType -
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    
    USER - On-demand backup created by you.
    
    SYSTEM - On-demand backup automatically created by DynamoDB.
    
    ALL - All types of on-demand backups (USER and SYSTEM).
    See Also:
    
    BackupTypeFilter
  - withBackupType
```
public ListBackupsRequest withBackupType(BackupTypeFilter backupType)
```
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    - USER - On-demand backup created by you.
    - SYSTEM - On-demand backup automatically created by DynamoDB.
    - ALL - All types of on-demand backups (USER and SYSTEM).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: USER, SYSTEM, ALL
    Parameters:
    backupType -
    The backups from the table specified by BackupType are listed.
    
    Where BackupType can be:
    
    USER - On-demand backup created by you.
    
    SYSTEM - On-demand backup automatically created by DynamoDB.
    
    ALL - All types of on-demand backups (USER and SYSTEM).
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    BackupTypeFilter
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ListBackupsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListBackupsRequest

Method Detail

getTableName

setTableName

withTableName

getLimit

setLimit

withLimit

getTimeRangeLowerBound

setTimeRangeLowerBound

withTimeRangeLowerBound

getTimeRangeUpperBound

setTimeRangeUpperBound

withTimeRangeUpperBound

getExclusiveStartBackupArn

setExclusiveStartBackupArn

withExclusiveStartBackupArn

getBackupType

setBackupType

withBackupType

setBackupType

withBackupType

toString

hashCode

equals