Class DescribeDBSnapshotsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeDBSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeDBSnapshotsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeDBSnapshotsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDBInstanceIdentifier()
A DB instance identifier to retrieve the list of DB snapshots for.String
getDBSnapshotIdentifier()
A specific DB snapshot identifier to describe.List<Filter>
getFilters()
This parameter is not currently supported.Boolean
getIncludePublic()
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false.Boolean
getIncludeShared()
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false.String
getMarker()
An optional pagination token provided by a previousDescribeDBSnapshots
request.Integer
getMaxRecords()
The maximum number of records to include in the response.String
getSnapshotType()
The type of snapshots that will be returned.int
hashCode()
Boolean
isIncludePublic()
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false.Boolean
isIncludeShared()
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false.void
setDBInstanceIdentifier(String dBInstanceIdentifier)
A DB instance identifier to retrieve the list of DB snapshots for.void
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
A specific DB snapshot identifier to describe.void
setFilters(Collection<Filter> filters)
This parameter is not currently supported.void
setIncludePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false.void
setIncludeShared(Boolean includeShared)
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false.void
setMarker(String marker)
An optional pagination token provided by a previousDescribeDBSnapshots
request.void
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.void
setSnapshotType(String snapshotType)
The type of snapshots that will be returned.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeDBSnapshotsRequest
withDBInstanceIdentifier(String dBInstanceIdentifier)
A DB instance identifier to retrieve the list of DB snapshots for.DescribeDBSnapshotsRequest
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
A specific DB snapshot identifier to describe.DescribeDBSnapshotsRequest
withFilters(Filter... filters)
This parameter is not currently supported.DescribeDBSnapshotsRequest
withFilters(Collection<Filter> filters)
This parameter is not currently supported.DescribeDBSnapshotsRequest
withIncludePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false.DescribeDBSnapshotsRequest
withIncludeShared(Boolean includeShared)
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false.DescribeDBSnapshotsRequest
withMarker(String marker)
An optional pagination token provided by a previousDescribeDBSnapshots
request.DescribeDBSnapshotsRequest
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.DescribeDBSnapshotsRequest
withSnapshotType(String snapshotType)
The type of snapshots that will be returned.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with
DBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
dBInstanceIdentifier
- A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction withDBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with
DBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- A DB instance identifier to retrieve the list of DB snapshots
for. This parameter cannot be used in conjunction with
DBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
withDBInstanceIdentifier
public DescribeDBSnapshotsRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with
DBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
dBInstanceIdentifier
- A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction withDBSnapshotIdentifier
. This parameter is not case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSnapshotIdentifier
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
- Parameters:
dBSnapshotIdentifier
- A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction withDBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
-
getDBSnapshotIdentifier
public String getDBSnapshotIdentifier()
A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
- Returns:
- A specific DB snapshot identifier to describe. This parameter
cannot be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
-
withDBSnapshotIdentifier
public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
- Parameters:
dBSnapshotIdentifier
- A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction withDBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotType
public void setSnapshotType(String snapshotType)
The type of snapshots that will be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.- Parameters:
snapshotType
- The type of snapshots that will be returned. You can specify one of the following values:automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.
-
getSnapshotType
public String getSnapshotType()
The type of snapshots that will be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.- Returns:
- The type of snapshots that will be returned. You can specify one
of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.
-
withSnapshotType
public DescribeDBSnapshotsRequest withSnapshotType(String snapshotType)
The type of snapshots that will be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.- Parameters:
snapshotType
- The type of snapshots that will be returned. You can specify one of the following values:automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a
SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters do not apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter does not apply whenSnapshotType
is set toshared
. theIncludeShared
parameter does not apply whenSnapshotType
is set topublic
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public List<Filter> getFilters()
This parameter is not currently supported.
- Returns:
- This parameter is not currently supported.
-
setFilters
public void setFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.
-
withFilters
public DescribeDBSnapshotsRequest withFilters(Filter... filters)
This parameter is not currently supported.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withFilters
public DescribeDBSnapshotsRequest withFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxRecords
public void setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
-
getMaxRecords
public Integer getMaxRecords()
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- The maximum number of records to include in the response. If more
records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
-
withMaxRecords
public DescribeDBSnapshotsRequest withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
public void setMarker(String marker)
An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
getMarker
public String getMarker()
An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Returns:
- An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
withMarker
public DescribeDBSnapshotsRequest withMarker(String marker)
An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeShared
public void setIncludeShared(Boolean includeShared)
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
- Parameters:
includeShared
- True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
-
getIncludeShared
public Boolean getIncludeShared()
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
- Returns:
- True to include shared manual DB snapshots from other AWS
accounts that this AWS account has been given permission to copy
or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
-
withIncludeShared
public DescribeDBSnapshotsRequest withIncludeShared(Boolean includeShared)
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
- Parameters:
includeShared
- True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludeShared
public Boolean isIncludeShared()
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
- Returns:
- True to include shared manual DB snapshots from other AWS
accounts that this AWS account has been given permission to copy
or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
-
setIncludePublic
public void setIncludePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
- Parameters:
includePublic
- True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
-
getIncludePublic
public Boolean getIncludePublic()
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
- Returns:
- True to include manual DB snapshots that are public and can be
copied or restored by any AWS account; otherwise false. The
default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
-
withIncludePublic
public DescribeDBSnapshotsRequest withIncludePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
- Parameters:
includePublic
- True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludePublic
public Boolean isIncludePublic()
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
- Returns:
- True to include manual DB snapshots that are public and can be
copied or restored by any AWS account; otherwise false. The
default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeDBSnapshotsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-