Class Checksum
- java.lang.Object
-
- software.amazon.awssdk.services.s3.model.Checksum
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Checksum.Builder,Checksum>
@Generated("software.amazon.awssdk:codegen") public final class Checksum extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Checksum.Builder,Checksum>
Contains all the possible checksum or digest values for an object.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Checksum.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Checksum.Builder
builder()
String
checksumCRC32()
The Base64 encoded, 32-bitCRC-32 checksum
of the object.String
checksumCRC32C()
The Base64 encoded, 32-bitCRC-32C
checksum of the object.String
checksumCRC64NVME()
The Base64 encoded, 64-bitCRC-64NVME
checksum of the object.String
checksumSHA1()
The Base64 encoded, 160-bitSHA-1
digest of the object.String
checksumSHA256()
The Base64 encoded, 256-bitSHA-256
digest of the object.ChecksumType
checksumType()
The checksum type that is used to calculate the object’s checksum value.String
checksumTypeAsString()
The checksum type that is used to calculate the object’s checksum value.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends Checksum.Builder>
serializableBuilderClass()
Checksum.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
checksumCRC32
public final String checksumCRC32()
The Base64 encoded, 32-bit
CRC-32 checksum
of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- The Base64 encoded, 32-bit
CRC-32 checksum
of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
-
checksumCRC32C
public final String checksumCRC32C()
The Base64 encoded, 32-bit
CRC-32C
checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- The Base64 encoded, 32-bit
CRC-32C
checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
-
checksumCRC64NVME
public final String checksumCRC64NVME()
The Base64 encoded, 64-bit
CRC-64NVME
checksum of the object. This checksum is present if the object was uploaded with theCRC-64NVME
checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum,CRC-64NVME
, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- The Base64 encoded, 64-bit
CRC-64NVME
checksum of the object. This checksum is present if the object was uploaded with theCRC-64NVME
checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum,CRC-64NVME
, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
-
checksumSHA1
public final String checksumSHA1()
The Base64 encoded, 160-bit
SHA-1
digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- The Base64 encoded, 160-bit
SHA-1
digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
-
checksumSHA256
public final String checksumSHA256()
The Base64 encoded, 256-bit
SHA-256
digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- The Base64 encoded, 256-bit
SHA-256
digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
-
checksumType
public final ChecksumType checksumType()
The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
If the service returns an enum value that is not available in the current SDK version,
checksumType
will returnChecksumType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumTypeAsString()
.- Returns:
- The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
- See Also:
ChecksumType
-
checksumTypeAsString
public final String checksumTypeAsString()
The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
If the service returns an enum value that is not available in the current SDK version,
checksumType
will returnChecksumType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumTypeAsString()
.- Returns:
- The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
- See Also:
ChecksumType
-
toBuilder
public Checksum.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Checksum.Builder,Checksum>
-
builder
public static Checksum.Builder builder()
-
serializableBuilderClass
public static Class<? extends Checksum.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-