Package software.amazon.awssdk.services.memorydb.model

Class DescribeSnapshotsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.memorydb.model.MemoryDbRequest

software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

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

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	clusterName()	A user-supplied cluster identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of records to include in the response.
String	nextToken()	An optional argument to pass in case the total number of records exceeds the value of MaxResults.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSnapshotsRequest.Builder>	serializableBuilderClass()
Boolean	showDetail()	A Boolean value which if true, the shard configuration is included in the snapshot description.
String	snapshotName()	A user-supplied name of the snapshot.
String	source()	If set to system, the output shows snapshots that were automatically created by MemoryDB.
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

clusterName

public final String clusterName()

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 named snapshot is described.

Returns:

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

source

public final String source()

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

nextToken

public final String nextToken()

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

maxResults

public final Integer maxResults()

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

showDetail

public final Boolean showDetail()

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

Returns:

A Boolean value which if true, the 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 MemoryDbRequest

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