com.amazonaws.services.elasticache.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeSnapshots operation.

The DescribeSnapshots action 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.

See Also:

AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeSnapshotsRequest	clone()
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() If set to system, the output shows snapshots that were automatically created by ElastiCache.
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) If set to system, the output shows snapshots that were automatically created by ElastiCache.
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) If set to system, 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, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getCacheClusterId

public String 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.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

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.

withCacheClusterId

public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId)

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotName

public String 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.

setSnapshotName

public void setSnapshotName(String snapshotName)

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.

withSnapshotName

public DescribeSnapshotsRequest withSnapshotName(String snapshotName)

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotSource

public String getSnapshotSource()

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user 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 to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

setSnapshotSource

public void setSnapshotSource(String snapshotSource)

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Parameters:

snapshotSource - If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

withSnapshotSource

public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource)

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotSource - If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String 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.

setMarker

public void setMarker(String 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.

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.

withMarker

public DescribeSnapshotsRequest withMarker(String 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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer 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.

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 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 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

public DescribeSnapshotsRequest withMaxRecords(Integer 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeSnapshotsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest