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

Class DescribeSnapshotsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeSnapshotsRequest
extends ElastiCacheRequest
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

Method Summary

Modifier and Type	Method	Description
static DescribeSnapshotsRequest.Builder	builder()
String	cacheClusterId()	A user-supplied cluster identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

replicationGroupId

public final 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 final String cacheClusterId()

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.

snapshotName

public final 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 final 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 final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static DescribeSnapshotsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo