Package software.amazon.awssdk.services.ebs.model

Class ListSnapshotBlocksRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ebs.model.EbsRequest

software.amazon.awssdk.services.ebs.model.ListSnapshotBlocksRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListSnapshotBlocksRequest.Builder,ListSnapshotBlocksRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListSnapshotBlocksRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListSnapshotBlocksRequest.Builder	builder()
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 blocks to be returned by the request.
String	nextToken()	The token to request the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListSnapshotBlocksRequest.Builder>	serializableBuilderClass()
String	snapshotId()	The ID of the snapshot from which to get block indexes and block tokens.
Integer	startingBlockIndex()	The block index from which the list should start.
ListSnapshotBlocksRequest.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

snapshotId

public final String snapshotId()

The ID of the snapshot from which to get block indexes and block tokens.

Returns:

The ID of the snapshot from which to get block indexes and block tokens.

nextToken

public final String nextToken()

The token to request the next page of results.

If you specify NextToken, then StartingBlockIndex is ignored.

Returns:

The token to request the next page of results.

If you specify NextToken, then StartingBlockIndex is ignored.

maxResults

public final Integer maxResults()

The maximum number of blocks to be returned by the request.

Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

Returns:

The maximum number of blocks to be returned by the request.

Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

startingBlockIndex

public final Integer startingBlockIndex()

The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

If you specify NextToken, then StartingBlockIndex is ignored.

Returns:

The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

If you specify NextToken, then StartingBlockIndex is ignored.

toBuilder

public ListSnapshotBlocksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSnapshotBlocksRequest.Builder,ListSnapshotBlocksRequest>

Specified by:

toBuilder in class EbsRequest

builder

public static ListSnapshotBlocksRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListSnapshotBlocksRequest.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