public class DescribeDBSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDBSnapshotsRequest() |
Modifier and Type | Method and 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 previous
DescribeDBSnapshots 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 previous
DescribeDBSnapshots 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(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeDBSnapshotsRequest |
withFilters(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 previous
DescribeDBSnapshots 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.
|
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
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:
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:
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:
DBSnapshotIdentifier
. This parameter is not
case-sensitive.
Constraints:
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:
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:
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:
SnapshotType
parameter must also be specified.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:
SnapshotType
parameter must also be specified.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:
SnapshotType
parameter must also be specified.DBInstanceIdentifier
. This value is stored as a
lowercase string.
Constraints:
SnapshotType
parameter must also be specified.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:
SnapshotType
parameter must also be specified.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:
SnapshotType
parameter must also be specified.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 the IncludeShared
parameter to
true
. You can include public snapshots with these results by
setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters
do not apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter does
not apply when SnapshotType
is set to shared
.
the IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
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 the
IncludeShared
parameter to true
. You can
include public snapshots with these results by setting the
IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters do not apply for SnapshotType
values of
manual
or automated
. The
IncludePublic
parameter does not apply when
SnapshotType
is set to shared
. the
IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
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 the IncludeShared
parameter to
true
. You can include public snapshots with these results by
setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters
do not apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter does
not apply when SnapshotType
is set to shared
.
the IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
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 the
IncludeShared
parameter to true
. You
can include public snapshots with these results by setting the
IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters do not apply for SnapshotType
values of
manual
or automated
. The
IncludePublic
parameter does not apply when
SnapshotType
is set to shared
. the
IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
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 the IncludeShared
parameter to
true
. You can include public snapshots with these results by
setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters
do not apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter does
not apply when SnapshotType
is set to shared
.
the IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
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 the
IncludeShared
parameter to true
. You can
include public snapshots with these results by setting the
IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters do not apply for SnapshotType
values of
manual
or automated
. The
IncludePublic
parameter does not apply when
SnapshotType
is set to shared
. the
IncludeShared
parameter does not apply when
SnapshotType
is set to public
.
public List<Filter> getFilters()
This parameter is not currently supported.
public void setFilters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.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)
or
withFilters(java.util.Collection)
if you want to override the
existing values.
filters
- This parameter is not currently supported.public DescribeDBSnapshotsRequest withFilters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.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.
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.
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.
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.
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.
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.
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 by MaxRecords
.
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 by MaxRecords
.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 by MaxRecords
.
DescribeDBSnapshots
request. If this parameter is
specified, the response includes only records beyond the marker,
up to the value specified by MaxRecords
.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 by MaxRecords
.
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 by MaxRecords
.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.
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.
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.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
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.
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.
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.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
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.
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.
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.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
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.
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.
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.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
public String toString()
toString
in class Object
Object.toString()
public DescribeDBSnapshotsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2018. All rights reserved.