Class PutObjectResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.s3.model.S3Response
-
- software.amazon.awssdk.services.s3.model.PutObjectResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>
@Generated("software.amazon.awssdk:codegen") public final class PutObjectResponse extends S3Response implements ToCopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutObjectResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanbucketKeyEnabled()Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).static PutObjectResponse.Builderbuilder()StringchecksumCRC32()The base64-encoded, 32-bit CRC32 checksum of the object.StringchecksumCRC32C()The base64-encoded, 32-bit CRC32C checksum of the object.StringchecksumSHA1()The base64-encoded, 160-bit SHA-1 digest of the object.StringchecksumSHA256()The base64-encoded, 256-bit SHA-256 digest of the object.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeTag()Entity tag for the uploaded object.Stringexpiration()If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()RequestChargedrequestCharged()Returns the value of the RequestCharged property for this object.StringrequestChargedAsString()Returns the value of the RequestCharged property for this object.List<SdkField<?>>sdkFields()static Class<? extends PutObjectResponse.Builder>serializableBuilderClass()ServerSideEncryptionserverSideEncryption()The server-side encryption algorithm used when storing this object in Amazon S3 (for example,AES256,aws:kms,aws:kms:dsse).StringserverSideEncryptionAsString()The server-side encryption algorithm used when storing this object in Amazon S3 (for example,AES256,aws:kms,aws:kms:dsse).StringsseCustomerAlgorithm()If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.StringsseCustomerKeyMD5()If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.StringssekmsEncryptionContext()If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption.StringssekmsKeyId()Ifx-amz-server-side-encryptionhas a valid value ofaws:kmsoraws:kms:dsse, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.PutObjectResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionId()Version of the object.-
Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
expiration
public final String expiration()
If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the
expiry-dateandrule-idkey-value pairs that provide information about object expiration. The value of therule-idis URL-encoded.- Returns:
- If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the
expiry-dateandrule-idkey-value pairs that provide information about object expiration. The value of therule-idis URL-encoded.
-
eTag
public final String eTag()
Entity tag for the uploaded object.
- Returns:
- Entity tag for the uploaded object.
-
checksumCRC32
public final String checksumCRC32()
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, 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 it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. 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 it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
-
serverSideEncryption
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256,aws:kms,aws:kms:dsse).If the service returns an enum value that is not available in the current SDK version,
serverSideEncryptionwill returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromserverSideEncryptionAsString().- Returns:
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256,aws:kms,aws:kms:dsse). - See Also:
ServerSideEncryption
-
serverSideEncryptionAsString
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256,aws:kms,aws:kms:dsse).If the service returns an enum value that is not available in the current SDK version,
serverSideEncryptionwill returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromserverSideEncryptionAsString().- Returns:
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256,aws:kms,aws:kms:dsse). - See Also:
ServerSideEncryption
-
versionId
public final String versionId()
Version of the object.
- Returns:
- Version of the object.
-
sseCustomerAlgorithm
public final String sseCustomerAlgorithm()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- Returns:
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
-
sseCustomerKeyMD5
public final String sseCustomerKeyMD5()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
- Returns:
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
-
ssekmsKeyId
public final String ssekmsKeyId()
If
x-amz-server-side-encryptionhas a valid value ofaws:kmsoraws:kms:dsse, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.- Returns:
- If
x-amz-server-side-encryptionhas a valid value ofaws:kmsoraws:kms:dsse, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
-
ssekmsEncryptionContext
public final String ssekmsEncryptionContext()
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObjectorCopyObjectoperations on this object.- Returns:
- If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The
value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value
pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services
KMS for future
GetObjectorCopyObjectoperations on this object.
-
bucketKeyEnabled
public final Boolean bucketKeyEnabled()
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- Returns:
- Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
-
requestCharged
public final RequestCharged requestCharged()
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestChargedwill returnRequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestChargedAsString().- Returns:
- The value of the RequestCharged property for this object.
- See Also:
RequestCharged
-
requestChargedAsString
public final String requestChargedAsString()
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestChargedwill returnRequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestChargedAsString().- Returns:
- The value of the RequestCharged property for this object.
- See Also:
RequestCharged
-
toBuilder
public PutObjectResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static PutObjectResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutObjectResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-