software.amazon.awssdk.services.s3.model

Class CopyObjectResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CopyObjectResponse
extends S3Response
implements ToCopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CopyObjectResponse.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	bucketKeyEnabled() Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
static CopyObjectResponse.Builder	builder()
CopyObjectResult	copyObjectResult() Container for all response elements.
String	copySourceVersionId() Version of the copied object in the destination bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expiration() If the object expiration is configured, 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 CopyObjectResponse.Builder>	serializableBuilderClass()
ServerSideEncryption	serverSideEncryption() The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
String	serverSideEncryptionAsString() The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
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 Amazon Web Services KMS Encryption Context to use for object encryption.
String	ssekmsKeyId() If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
CopyObjectResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionId() Version ID of the newly created copy.

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

copyObjectResult

public final CopyObjectResult copyObjectResult()

Container for all response elements.

Returns:

Container for all response elements.

expiration

public final String expiration()

If the object expiration is configured, the response includes this header.

Returns:

If the object expiration is configured, the response includes this header.

copySourceVersionId

public final String copySourceVersionId()

Version of the copied object in the destination bucket.

Returns:

Version of the copied object in the destination bucket.

versionId

public final String versionId()

Version ID of the newly created copy.

Returns:

Version ID of the newly created copy.

serverSideEncryption

public final ServerSideEncryption serverSideEncryption()

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

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:

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

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

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:

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

See Also:

ServerSideEncryption

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 present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

Returns:

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric 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.

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.

bucketKeyEnabled

public final Boolean bucketKeyEnabled()

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

Returns:

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services 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 CopyObjectResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CopyObjectResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CopyObjectResponse.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