software.amazon.awssdk.services.directory.model

Class DescribeSnapshotsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

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

Contains the inputs for the DescribeSnapshots operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSnapshotsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeSnapshotsRequest.Builder	builder()
String	directoryId() The identifier of the directory for which to retrieve snapshot information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSnapshotIds() Returns true if the SnapshotIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	limit() The maximum number of objects to return.
String	nextToken() The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSnapshotsRequest.Builder>	serializableBuilderClass()
List<String>	snapshotIds() A list of identifiers of the snapshots to obtain the information for.
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

directoryId

public final String directoryId()

The identifier of the directory for which to retrieve snapshot information.

Returns:

The identifier of the directory for which to retrieve snapshot information.

hasSnapshotIds

public final boolean hasSnapshotIds()

Returns true if the SnapshotIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

snapshotIds

public final List<String> snapshotIds()

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSnapshotIds() to see if a value was sent in this field.

Returns:

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

nextToken

public final String nextToken()

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Returns:

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

limit

public final Integer limit()

The maximum number of objects to return.

Returns:

The maximum number of objects to return.

toBuilder

public DescribeSnapshotsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Specified by:

toBuilder in class DirectoryRequest

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