Class DescribeDBClusterSnapshotsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeDBClusterSnapshotsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 previousDescribeDBClusterSnapshots
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 previousDescribeDBClusterSnapshots
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(Filter... filters)
This parameter is not currently supported.DescribeDBClusterSnapshotsRequest
withFilters(Collection<Filter> filters)
This parameter is not currently supported.DescribeDBClusterSnapshotsRequest
withMarker(String marker)
An optional pagination token provided by a previousDescribeDBClusterSnapshots
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.-
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
-
setDBClusterIdentifier
public void setDBClusterIdentifier(String 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:
- 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:
dBClusterIdentifier
- A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with theDBClusterSnapshotIdentifier
parameter. 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
-
getDBClusterIdentifier
public String getDBClusterIdentifier()
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:
- 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 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:
- 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
-
withDBClusterIdentifier
public DescribeDBClusterSnapshotsRequest withDBClusterIdentifier(String 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:
- 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:
dBClusterIdentifier
- A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with theDBClusterSnapshotIdentifier
parameter. 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.
-
setDBClusterSnapshotIdentifier
public void setDBClusterSnapshotIdentifier(String 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:
- 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:
dBClusterSnapshotIdentifier
- A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with theDBClusterIdentifier
parameter. 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.
-
getDBClusterSnapshotIdentifier
public String getDBClusterSnapshotIdentifier()
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:
- 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 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:
- 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.
-
withDBClusterSnapshotIdentifier
public DescribeDBClusterSnapshotsRequest withDBClusterSnapshotIdentifier(String 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:
- 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:
dBClusterSnapshotIdentifier
- A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with theDBClusterIdentifier
parameter. 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 DB cluster snapshots that will be returned. Values can be
automated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.- Parameters:
snapshotType
- The type of DB cluster snapshots that will be returned. Values can beautomated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.
-
getSnapshotType
public String getSnapshotType()
The type of DB cluster snapshots that will be returned. Values can be
automated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.- Returns:
- The type of DB cluster snapshots that will be returned. Values
can be
automated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.
-
withSnapshotType
public DescribeDBClusterSnapshotsRequest withSnapshotType(String snapshotType)
The type of DB cluster snapshots that will be returned. Values can be
automated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.- Parameters:
snapshotType
- The type of DB cluster snapshots that will be returned. Values can beautomated
ormanual
. If this parameter is not specified, the returned results will include all snapshot types.- 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 DescribeDBClusterSnapshotsRequest 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 DescribeDBClusterSnapshotsRequest 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 DescribeDBClusterSnapshotsRequest 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
DescribeDBClusterSnapshots
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 previousDescribeDBClusterSnapshots
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
DescribeDBClusterSnapshots
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
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
withMarker
public DescribeDBClusterSnapshotsRequest withMarker(String 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 byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBClusterSnapshots
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.
-
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 DescribeDBClusterSnapshotsRequest 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()
-
-