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

Class CompleteSnapshotRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CompleteSnapshotRequest.Builder,CompleteSnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompleteSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CompleteSnapshotRequest.Builder	builder()
Integer	changedBlocksCount()	The number of blocks that were written to the snapshot.
String	checksum()	An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
ChecksumAggregationMethod	checksumAggregationMethod()	The aggregation method used to generate the checksum.
String	checksumAggregationMethodAsString()	The aggregation method used to generate the checksum.
ChecksumAlgorithm	checksumAlgorithm()	The algorithm used to generate the checksum.
String	checksumAlgorithmAsString()	The algorithm used to generate the checksum.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CompleteSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotId()	The ID of the snapshot.
CompleteSnapshotRequest.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.

Returns:

The ID of the snapshot.

changedBlocksCount

public final Integer changedBlocksCount()

The number of blocks that were written to the snapshot.

Returns:

The number of blocks that were written to the snapshot.

checksum

public final String checksum()

An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

Returns:

An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

checksumAlgorithm

public final ChecksumAlgorithm checksumAlgorithm()

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

See Also:

ChecksumAlgorithm

checksumAlgorithmAsString

public final String checksumAlgorithmAsString()

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

See Also:

ChecksumAlgorithm

checksumAggregationMethod

public final ChecksumAggregationMethod checksumAggregationMethod()

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

If the service returns an enum value that is not available in the current SDK version, checksumAggregationMethod will return ChecksumAggregationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAggregationMethodAsString().

Returns:

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

See Also:

ChecksumAggregationMethod

checksumAggregationMethodAsString

public final String checksumAggregationMethodAsString()

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

If the service returns an enum value that is not available in the current SDK version, checksumAggregationMethod will return ChecksumAggregationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAggregationMethodAsString().

Returns:

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

See Also:

ChecksumAggregationMethod

toBuilder

public CompleteSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CompleteSnapshotRequest.Builder,CompleteSnapshotRequest>

Specified by:

toBuilder in class EbsRequest

builder

public static CompleteSnapshotRequest.Builder builder()

serializableBuilderClass

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