Class CopyObjectResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopyObjectResponse.Builder,
CopyObjectResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).static CopyObjectResponse.Builder
builder()
final CopyObjectResult
Container for all response elements.final String
Version ID of the source object that was copied.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If the object expiration is configured, the response includes this header.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final RequestCharged
Returns the value of the RequestCharged property for this object.final String
Returns the value of the RequestCharged property for this object.static Class
<? extends CopyObjectResponse.Builder> final ServerSideEncryption
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).final String
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).final String
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.final String
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.final String
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.final String
If present, indicates the ID of the KMS key that was used for object encryption.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
copyObjectResult
Container for all response elements.
- Returns:
- Container for all response elements.
-
expiration
If the object expiration is configured, the response includes this header.
This functionality is not supported for directory buckets.
- Returns:
- If the object expiration is configured, the response includes this header.
This functionality is not supported for directory buckets.
-
copySourceVersionId
Version ID of the source object that was copied.
This functionality is not supported when the source object is in a directory bucket.
- Returns:
- Version ID of the source object that was copied.
This functionality is not supported when the source object is in a directory bucket.
-
versionId
Version ID of the newly created copy.
This functionality is not supported for directory buckets.
- Returns:
- Version ID of the newly created copy.
This functionality is not supported for directory buckets.
-
serverSideEncryption
The server-side encryption algorithm used when you store 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,
serverSideEncryption
will returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverSideEncryptionAsString()
.- Returns:
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - See Also:
-
serverSideEncryptionAsString
The server-side encryption algorithm used when you store 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,
serverSideEncryption
will returnServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverSideEncryptionAsString()
.- Returns:
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - See Also:
-
sseCustomerAlgorithm
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
- Returns:
- If server-side encryption with a customer-provided encryption key was requested, the response will
include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
-
sseCustomerKeyMD5
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
- Returns:
- If server-side encryption with a customer-provided encryption key was requested, the response will
include this header to provide the round-trip message integrity verification of the customer-provided
encryption key.
This functionality is not supported for directory buckets.
-
ssekmsKeyId
If present, indicates the ID of the KMS key that was used for object encryption.
- Returns:
- If present, indicates the ID of the KMS key that was used for object encryption.
-
ssekmsEncryptionContext
If present, indicates 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, indicates 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
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- Returns:
- Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
-
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 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:
-
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 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:
-
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 interfaceToCopyableBuilder<CopyObjectResponse.Builder,
CopyObjectResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-