public class ListBackupsRequest extends 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.
Constructor and Description |
---|
ListBackupsRequest() |
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.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getTableName()
The backups from the table specified by TableName
are
listed.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The backups from the table specified by TableName
are listed.
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_.-]+
tableName
-
The backups from the table specified by TableName
are listed.
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_.-]+
tableName
-
The backups from the table specified by TableName
are listed.
public java.lang.Integer getLimit()
Maximum number of backups to return at once.
Constraints:
Range: 1 - 100
Maximum number of backups to return at once.
public void setLimit(java.lang.Integer limit)
Maximum number of backups to return at once.
Constraints:
Range: 1 - 100
limit
- Maximum number of backups to return at once.
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
limit
- Maximum number of backups to return at once.
public java.util.Date getTimeRangeLowerBound()
Only backups created after this time are listed.
TimeRangeLowerBound
is inclusive.
Only backups created after this time are listed.
TimeRangeLowerBound
is inclusive.
public void setTimeRangeLowerBound(java.util.Date timeRangeLowerBound)
Only backups created after this time are listed.
TimeRangeLowerBound
is inclusive.
timeRangeLowerBound
-
Only backups created after this time are listed.
TimeRangeLowerBound
is inclusive.
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.
timeRangeLowerBound
-
Only backups created after this time are listed.
TimeRangeLowerBound
is inclusive.
public java.util.Date getTimeRangeUpperBound()
Only backups created before this time are listed.
TimeRangeUpperBound
is exclusive.
Only backups created before this time are listed.
TimeRangeUpperBound
is exclusive.
public void setTimeRangeUpperBound(java.util.Date timeRangeUpperBound)
Only backups created before this time are listed.
TimeRangeUpperBound
is exclusive.
timeRangeUpperBound
-
Only backups created before this time are listed.
TimeRangeUpperBound
is exclusive.
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.
timeRangeUpperBound
-
Only backups created before this time are listed.
TimeRangeUpperBound
is exclusive.
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
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.
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
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.
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
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.
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
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).
BackupTypeFilter
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
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).
BackupTypeFilter
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
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).
BackupTypeFilter
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
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).
BackupTypeFilter
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
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).
BackupTypeFilter
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.