Class DescribeSnapshotsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a DescribeSnapshotsMessage action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A user-supplied cluster identifier.An optional marker returned from a prior request.The maximum number of records to include in the response.A user-supplied name of the snapshot.If set tosystem
, the output shows snapshots that were automatically created by ElastiCache.int
hashCode()
void
setCacheClusterId
(String cacheClusterId) A user-supplied cluster identifier.void
An optional marker returned from a prior request.void
setMaxRecords
(Integer maxRecords) The maximum number of records to include in the response.void
setSnapshotName
(String snapshotName) A user-supplied name of the snapshot.void
setSnapshotSource
(String snapshotSource) If set tosystem
, the output shows snapshots that were automatically created by ElastiCache.toString()
Returns a string representation of this object; useful for testing and debugging.withCacheClusterId
(String cacheClusterId) A user-supplied cluster identifier.withMarker
(String marker) An optional marker returned from a prior request.withMaxRecords
(Integer maxRecords) The maximum number of records to include in the response.withSnapshotName
(String snapshotName) A user-supplied name of the snapshot.withSnapshotSource
(String snapshotSource) If set tosystem
, the output shows snapshots that were automatically created by ElastiCache.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
-
Constructor Details
-
DescribeSnapshotsRequest
public DescribeSnapshotsRequest()
-
-
Method Details
-
setCacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
- Parameters:
cacheClusterId
- A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
-
getCacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
- Returns:
- A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
-
withCacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
- Parameters:
cacheClusterId
- A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
- Parameters:
snapshotName
- A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
-
getSnapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
- Returns:
- A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
-
withSnapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
- Parameters:
snapshotName
- A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotSource
If set to
system
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Parameters:
snapshotSource
- If set tosystem
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
-
getSnapshotSource
If set to
system
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Returns:
- If set to
system
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
-
withSnapshotSource
If set to
system
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Parameters:
snapshotSource
- If set tosystem
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Parameters:
marker
- An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
-
getMarker
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Returns:
- An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
-
withMarker
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Parameters:
marker
- An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
-
getMaxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Returns:
- The maximum number of records to include in the response. If more
records exist than the specified
MaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
-
withMaxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-