Package software.amazon.awssdk.services.elasticache.model

Class DescribeSnapshotsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Represents the input of a DescribeSnapshotsMessage operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSnapshotsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeSnapshotsRequest.Builder	builder()
String	cacheClusterId()	A user-supplied cluster identifier.
boolean	equals(Object obj)
int	hashCode()
String	marker()	An optional marker returned from a prior request.
Integer	maxRecords()	The maximum number of records to include in the response.
String	replicationGroupId()	A user-supplied replication group identifier.
static Class<? extends DescribeSnapshotsRequest.Builder>	serializableBuilderClass()
Boolean	showNodeGroupConfig()	A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
String	snapshotName()	A user-supplied name of the snapshot.
String	snapshotSource()	If set to system, the output shows snapshots that were automatically created by ElastiCache.
DescribeSnapshotsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

replicationGroupId

public String replicationGroupId()

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.

cacheClusterId

public String cacheClusterId()

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

Returns:

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

snapshotName

public String snapshotName()

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.

snapshotSource

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

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.

marker

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

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.

maxRecords

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

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.

showNodeGroupConfig

public Boolean showNodeGroupConfig()

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.

toBuilder

public DescribeSnapshotsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Returns:

a builder for type T

builder

public static DescribeSnapshotsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSnapshotsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object