public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable
DescribeSnapshots operation
.
The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
Constructor and Description |
---|
DescribeSnapshotsRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getCacheClusterId()
A user-supplied cluster identifier.
|
String |
getMarker()
An optional marker returned from a prior request.
|
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
String |
getSnapshotName()
A user-supplied name of the snapshot.
|
String |
getSnapshotSource()
Indicates whether the snapshot is from an automatic backup
(
automated ) or was created manually
(manual ). |
int |
hashCode() |
void |
setCacheClusterId(String cacheClusterId)
A user-supplied cluster identifier.
|
void |
setMarker(String marker)
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)
Indicates whether the snapshot is from an automatic backup
(
automated ) or was created manually
(manual ). |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeSnapshotsRequest |
withCacheClusterId(String cacheClusterId)
A user-supplied cluster identifier.
|
DescribeSnapshotsRequest |
withMarker(String marker)
An optional marker returned from a prior request.
|
DescribeSnapshotsRequest |
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeSnapshotsRequest |
withSnapshotName(String snapshotName)
A user-supplied name of the snapshot.
|
DescribeSnapshotsRequest |
withSnapshotSource(String snapshotSource)
Indicates whether the snapshot is from an automatic backup
(
automated ) or was created manually
(manual ). |
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public String getCacheClusterId()
public void setCacheClusterId(String cacheClusterId)
cacheClusterId
- A user-supplied cluster identifier. If this parameter is specified,
only snapshots associated with that specific cache cluster will be
described.public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId)
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- A user-supplied cluster identifier. If this parameter is specified,
only snapshots associated with that specific cache cluster will be
described.public String getSnapshotName()
public void setSnapshotName(String snapshotName)
snapshotName
- A user-supplied name of the snapshot. If this parameter is specified,
only this snapshot will be described.public DescribeSnapshotsRequest withSnapshotName(String snapshotName)
Returns a reference to this object so that method calls can be chained together.
snapshotName
- A user-supplied name of the snapshot. If this parameter is specified,
only this snapshot will be described.public String getSnapshotSource()
automated
) or was created manually
(manual
).automated
) or was created manually
(manual
).public void setSnapshotSource(String snapshotSource)
automated
) or was created manually
(manual
).snapshotSource
- Indicates whether the snapshot is from an automatic backup
(automated
) or was created manually
(manual
).public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource)
automated
) or was created manually
(manual
).
Returns a reference to this object so that method calls can be chained together.
snapshotSource
- Indicates whether the snapshot is from an automatic backup
(automated
) or was created manually
(manual
).public String getMarker()
public void setMarker(String marker)
marker
- An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.public DescribeSnapshotsRequest withMarker(String marker)
Returns a reference to this object so that method calls can be chained together.
marker
- An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.public Integer getMaxRecords()
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
public void setMaxRecords(Integer maxRecords)
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
maxRecords
- 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.
public DescribeSnapshotsRequest withMaxRecords(Integer maxRecords)
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 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
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.