public class DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DescribeDBClusterSnapshots operation.
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOOP| Constructor and Description |
|---|
DescribeDBClusterSnapshotsRequest() |
| Modifier and Type | Method and Description |
|---|---|
DescribeDBClusterSnapshotsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDBClusterIdentifier()
A DB cluster identifier to retrieve the list of DB cluster snapshots
for.
|
String |
getDBClusterSnapshotIdentifier()
A specific DB cluster snapshot identifier to describe.
|
List<Filter> |
getFilters()
This parameter is not currently supported.
|
String |
getMarker()
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
String |
getSnapshotType()
The type of DB cluster snapshots that will be returned.
|
int |
hashCode() |
void |
setDBClusterIdentifier(String dBClusterIdentifier)
A DB cluster identifier to retrieve the list of DB cluster snapshots
for.
|
void |
setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe.
|
void |
setFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
void |
setMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
void |
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
void |
setSnapshotType(String snapshotType)
The type of DB cluster snapshots that will be returned.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeDBClusterSnapshotsRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
A DB cluster identifier to retrieve the list of DB cluster snapshots
for.
|
DescribeDBClusterSnapshotsRequest |
withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe.
|
DescribeDBClusterSnapshotsRequest |
withFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeDBClusterSnapshotsRequest |
withFilters(Filter... filters)
This parameter is not currently supported.
|
DescribeDBClusterSnapshotsRequest |
withMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
DescribeDBClusterSnapshotsRequest |
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeDBClusterSnapshotsRequest |
withSnapshotType(String snapshotType)
The type of DB cluster snapshots that will be returned.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic String getDBClusterIdentifier()
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
public void setDBClusterIdentifier(String dBClusterIdentifier)
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
dBClusterIdentifier - A DB cluster identifier to retrieve the list of DB cluster snapshots
for. This parameter cannot be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
public DescribeDBClusterSnapshotsRequest withDBClusterIdentifier(String dBClusterIdentifier)
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
Returns a reference to this object so that method calls can be chained together.
dBClusterIdentifier - A DB cluster identifier to retrieve the list of DB cluster snapshots
for. This parameter cannot be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
public String getDBClusterSnapshotIdentifier()
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.dBClusterSnapshotIdentifier - A specific DB cluster snapshot identifier to describe. This parameter
cannot be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.public DescribeDBClusterSnapshotsRequest withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.Returns a reference to this object so that method calls can be chained together.
dBClusterSnapshotIdentifier - A specific DB cluster snapshot identifier to describe. This parameter
cannot be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.public String getSnapshotType()
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.public void setSnapshotType(String snapshotType)
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.snapshotType - The type of DB cluster snapshots that will be returned. Values can be
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.public DescribeDBClusterSnapshotsRequest withSnapshotType(String snapshotType)
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.
Returns a reference to this object so that method calls can be chained together.
snapshotType - The type of DB cluster snapshots that will be returned. Values can be
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.public List<Filter> getFilters()
public void setFilters(Collection<Filter> filters)
filters - This parameter is not currently supported.public DescribeDBClusterSnapshotsRequest withFilters(Filter... filters)
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.
Returns a reference to this object so that method calls can be chained together.
filters - This parameter is not currently supported.public DescribeDBClusterSnapshotsRequest withFilters(Collection<Filter> filters)
Returns a reference to this object so that method calls can be chained together.
filters - This parameter is not currently supported.public Integer getMaxRecords()
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 void setMaxRecords(Integer maxRecords)
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 DescribeDBClusterSnapshotsRequest withMaxRecords(Integer maxRecords)
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 a reference to this object so that method calls can be chained together.
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 String getMarker()
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.public void setMarker(String marker)
DescribeDBClusterSnapshots 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
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.public DescribeDBClusterSnapshotsRequest withMarker(String marker)
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
Returns a reference to this object so that method calls can be chained together.
marker - An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.public String toString()
toString in class ObjectObject.toString()public DescribeDBClusterSnapshotsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.