software.amazon.awssdk.services.s3.model

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutObjectResponse.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	bucketKeyEnabled() Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
static PutObjectResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eTag() Entity tag for the uploaded object.
String	expiration() If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RequestCharged	requestCharged() Returns the value of the RequestCharged property for this object.
String	requestChargedAsString() Returns the value of the RequestCharged property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends PutObjectResponse.Builder>	serializableBuilderClass()
ServerSideEncryption	serverSideEncryption() If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header.
String	serverSideEncryptionAsString() If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header.
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.
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.
String	ssekmsEncryptionContext() If present, specifies the AWS KMS Encryption Context to use for object encryption.
String	ssekmsKeyId() If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
PutObjectResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionId() 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-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

Returns:

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

eTag

public final String eTag()

Entity tag for the uploaded object.

Returns:

Entity tag for the uploaded object.

serverSideEncryption

public final ServerSideEncryption serverSideEncryption()

If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().

Returns:

If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

See Also:

ServerSideEncryption

serverSideEncryptionAsString

public final String serverSideEncryptionAsString()

If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().

Returns:

If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

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-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

ssekmsEncryptionContext

public final String ssekmsEncryptionContext()

If present, specifies the AWS 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.

Returns:

If present, specifies the AWS 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.

bucketKeyEnabled

public final Boolean bucketKeyEnabled()

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

Returns:

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (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, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().

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, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

toBuilder

public PutObjectResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static PutObjectResponse.Builder builder()

serializableBuilderClass

public static Class<? extends PutObjectResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo