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("software.amazon.awssdk:codegen") public final class PutSnapshotBlockRequest extends EbsRequest implements ToCopyableBuilder<PutSnapshotBlockRequest.Builder,PutSnapshotBlockRequest>

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public PutSnapshotBlockRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutSnapshotBlockRequest.Builder,PutSnapshotBlockRequest>
      Specified by:
      toBuilder in class EbsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.