software.amazon.awssdk.services.ebs.model

Class PutSnapshotBlockRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutSnapshotBlockRequest.Builder,PutSnapshotBlockRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutSnapshotBlockRequest.Builder

Method Summary

Modifier and Type	Method and Description
Integer	blockIndex() The block index of the block in which to write the data.
static PutSnapshotBlockRequest.Builder	builder()
String	checksum() A Base64-encoded SHA256 checksum of the data.
ChecksumAlgorithm	checksumAlgorithm() The algorithm used to generate the checksum.
String	checksumAlgorithmAsString() The algorithm used to generate the checksum.
Integer	dataLength() The size of the data to write to the block, in bytes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	progress() The progress of the write process, as a percentage.
List<SdkField<?>>	sdkFields()
static Class<? extends PutSnapshotBlockRequest.Builder>	serializableBuilderClass()
String	snapshotId() The ID of the snapshot.
PutSnapshotBlockRequest.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.

If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..

Returns:

The ID of the snapshot.

If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..

blockIndex

public final Integer blockIndex()

The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

Returns:

The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

dataLength

public final Integer dataLength()

The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.

Valid values: 524288

Returns:

The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.

Valid values: 524288

progress

public final Integer progress()

The progress of the write process, as a percentage.

Returns:

The progress of the write process, as a percentage.

checksum

public final String checksum()

A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

Returns:

A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

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

toBuilder

public PutSnapshotBlockRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutSnapshotBlockRequest.Builder,PutSnapshotBlockRequest>

Specified by:

toBuilder in class EbsRequest

builder

public static PutSnapshotBlockRequest.Builder builder()

serializableBuilderClass

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