com.amazonaws.services.ebs.model

Class PutSnapshotBlockRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ebs.model.PutSnapshotBlockRequest

All Implemented Interfaces:

SignerTypeAware, HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutSnapshotBlockRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, SignerTypeAware

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutSnapshotBlockRequest()

Method Summary

Modifier and Type	Method and Description
PutSnapshotBlockRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
InputStream	getBlockData() The data to write to the block.
Integer	getBlockIndex() The block index of the block in which to write the data.
String	getChecksum() A Base64-encoded SHA256 checksum of the data.
String	getChecksumAlgorithm() The algorithm used to generate the checksum.
Integer	getDataLength() The size of the data to write to the block, in bytes.
Integer	getProgress() The progress of the write process, as a percentage.
String	getSignerType()
String	getSnapshotId() The ID of the snapshot.
int	hashCode()
void	setBlockData(InputStream blockData) The data to write to the block.
void	setBlockIndex(Integer blockIndex) The block index of the block in which to write the data.
void	setChecksum(String checksum) A Base64-encoded SHA256 checksum of the data.
void	setChecksumAlgorithm(String checksumAlgorithm) The algorithm used to generate the checksum.
void	setDataLength(Integer dataLength) The size of the data to write to the block, in bytes.
void	setProgress(Integer progress) The progress of the write process, as a percentage.
void	setSnapshotId(String snapshotId) The ID of the snapshot.
String	toString() Returns a string representation of this object.
PutSnapshotBlockRequest	withBlockData(InputStream blockData) The data to write to the block.
PutSnapshotBlockRequest	withBlockIndex(Integer blockIndex) The block index of the block in which to write the data.
PutSnapshotBlockRequest	withChecksum(String checksum) A Base64-encoded SHA256 checksum of the data.
PutSnapshotBlockRequest	withChecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) The algorithm used to generate the checksum.
PutSnapshotBlockRequest	withChecksumAlgorithm(String checksumAlgorithm) The algorithm used to generate the checksum.
PutSnapshotBlockRequest	withDataLength(Integer dataLength) The size of the data to write to the block, in bytes.
PutSnapshotBlockRequest	withProgress(Integer progress) The progress of the write process, as a percentage.
PutSnapshotBlockRequest	withSnapshotId(String snapshotId) The ID of the snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutSnapshotBlockRequest

public PutSnapshotBlockRequest()

Method Detail

setSnapshotId

public void setSnapshotId(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..

Parameters:

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

getSnapshotId

public String getSnapshotId()

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

withSnapshotId

public PutSnapshotBlockRequest withSnapshotId(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..

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setBlockIndex

public void setBlockIndex(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.

Parameters:

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.

getBlockIndex

public Integer getBlockIndex()

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.

withBlockIndex

public PutSnapshotBlockRequest withBlockIndex(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setBlockData

public void setBlockData(InputStream blockData)

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Parameters:

blockData - The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

getBlockData

public InputStream getBlockData()

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Returns:

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

withBlockData

public PutSnapshotBlockRequest withBlockData(InputStream blockData)

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Parameters:

blockData - The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataLength

public void setDataLength(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

Parameters:

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

Valid values: 524288

getDataLength

public Integer getDataLength()

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

withDataLength

public PutSnapshotBlockRequest withDataLength(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setProgress

public void setProgress(Integer progress)

The progress of the write process, as a percentage.

Parameters:

progress - The progress of the write process, as a percentage.

getProgress

public Integer getProgress()

The progress of the write process, as a percentage.

Returns:

The progress of the write process, as a percentage.

withProgress

public PutSnapshotBlockRequest withProgress(Integer progress)

The progress of the write process, as a percentage.

Parameters:

progress - The progress of the write process, as a percentage.

Returns:

Returns a reference to this object so that method calls can be chained together.

setChecksum

public void setChecksum(String checksum)

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

Parameters:

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

getChecksum

public String getChecksum()

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.

withChecksum

public PutSnapshotBlockRequest withChecksum(String checksum)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setChecksumAlgorithm

public void setChecksumAlgorithm(String checksumAlgorithm)

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

Parameters:

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

See Also:

ChecksumAlgorithm

getChecksumAlgorithm

public String getChecksumAlgorithm()

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

Returns:

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

See Also:

ChecksumAlgorithm

withChecksumAlgorithm

public PutSnapshotBlockRequest withChecksumAlgorithm(String checksumAlgorithm)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChecksumAlgorithm

withChecksumAlgorithm

public PutSnapshotBlockRequest withChecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChecksumAlgorithm

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutSnapshotBlockRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()

getSignerType

public String getSignerType()

Specified by:

getSignerType in interface SignerTypeAware