com.amazonaws.services.elasticache.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a DescribeSnapshotsMessage operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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	getReplicationGroupId() A user-supplied replication group identifier.
Boolean	getShowNodeGroupConfig() A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
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()
Boolean	isShowNodeGroupConfig() A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
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	setReplicationGroupId(String replicationGroupId) A user-supplied replication group identifier.
void	setShowNodeGroupConfig(Boolean showNodeGroupConfig) A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
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.
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	withReplicationGroupId(String replicationGroupId) A user-supplied replication group identifier.
DescribeSnapshotsRequest	withShowNodeGroupConfig(Boolean showNodeGroupConfig) A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

Parameters:

replicationGroupId - A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

getReplicationGroupId

public String getReplicationGroupId()

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

Returns:

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

withReplicationGroupId

public DescribeSnapshotsRequest withReplicationGroupId(String replicationGroupId)

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

Parameters:

replicationGroupId - A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

Returns:

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

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

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

Parameters:

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

getCacheClusterId

public String getCacheClusterId()

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

Returns:

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

withCacheClusterId

public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId)

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

Parameters:

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

Returns:

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

setSnapshotName

public void setSnapshotName(String snapshotName)

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

Parameters:

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

getSnapshotName

public String getSnapshotName()

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

Returns:

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

withSnapshotName

public DescribeSnapshotsRequest withSnapshotName(String snapshotName)

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

Parameters:

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

Returns:

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

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.

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.

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.

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:

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

setMarker

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

Parameters:

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.

getMarker

public String getMarker()

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.

Returns:

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.

withMarker

public DescribeSnapshotsRequest withMarker(String 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.

Parameters:

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.

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

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.

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.

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:

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

setShowNodeGroupConfig

public void setShowNodeGroupConfig(Boolean showNodeGroupConfig)

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Parameters:

showNodeGroupConfig - A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

getShowNodeGroupConfig

public Boolean getShowNodeGroupConfig()

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Returns:

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

withShowNodeGroupConfig

public DescribeSnapshotsRequest withShowNodeGroupConfig(Boolean showNodeGroupConfig)

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Parameters:

showNodeGroupConfig - A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Returns:

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

isShowNodeGroupConfig

public Boolean isShowNodeGroupConfig()

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Returns:

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeSnapshotsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()