Interface CopyObjectResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>
,S3Response.Builder
,SdkBuilder<CopyObjectResponse.Builder,CopyObjectResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- CopyObjectResponse
public static interface CopyObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CopyObjectResponse.Builder
bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).default CopyObjectResponse.Builder
copyObjectResult(Consumer<CopyObjectResult.Builder> copyObjectResult)
Container for all response elements.CopyObjectResponse.Builder
copyObjectResult(CopyObjectResult copyObjectResult)
Container for all response elements.CopyObjectResponse.Builder
copySourceVersionId(String copySourceVersionId)
Version ID of the source object that was copied.CopyObjectResponse.Builder
expiration(String expiration)
If the object expiration is configured, the response includes this header.CopyObjectResponse.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.CopyObjectResponse.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.CopyObjectResponse.Builder
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).CopyObjectResponse.Builder
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).CopyObjectResponse.Builder
sseCustomerAlgorithm(String 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.CopyObjectResponse.Builder
sseCustomerKeyMD5(String 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.CopyObjectResponse.Builder
ssekmsEncryptionContext(String ssekmsEncryptionContext)
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.CopyObjectResponse.Builder
ssekmsKeyId(String ssekmsKeyId)
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.CopyObjectResponse.Builder
versionId(String versionId)
Version ID of the newly created copy.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
copyObjectResult
CopyObjectResponse.Builder copyObjectResult(CopyObjectResult copyObjectResult)
Container for all response elements.
- Parameters:
copyObjectResult
- Container for all response elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyObjectResult
default CopyObjectResponse.Builder copyObjectResult(Consumer<CopyObjectResult.Builder> copyObjectResult)
Container for all response elements.
This is a convenience method that creates an instance of theCopyObjectResult.Builder
avoiding the need to create one manually viaCopyObjectResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocopyObjectResult(CopyObjectResult)
.- Parameters:
copyObjectResult
- a consumer that will call methods onCopyObjectResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
copyObjectResult(CopyObjectResult)
-
expiration
CopyObjectResponse.Builder expiration(String expiration)
If the object expiration is configured, the response includes this header.
This functionality is not supported for directory buckets.
- Parameters:
expiration
- If the object expiration is configured, the response includes this header.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copySourceVersionId
CopyObjectResponse.Builder copySourceVersionId(String copySourceVersionId)
Version ID of the source object that was copied.
This functionality is not supported when the source object is in a directory bucket.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
CopyObjectResponse.Builder versionId(String versionId)
Version ID of the newly created copy.
This functionality is not supported for directory buckets.
- Parameters:
versionId
- Version ID of the newly created copy.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverSideEncryption
CopyObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServerSideEncryption
,ServerSideEncryption
-
serverSideEncryption
CopyObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServerSideEncryption
,ServerSideEncryption
-
sseCustomerAlgorithm
CopyObjectResponse.Builder sseCustomerAlgorithm(String 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sseCustomerKeyMD5
CopyObjectResponse.Builder sseCustomerKeyMD5(String 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
ssekmsKeyId
CopyObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
This functionality is not supported for directory buckets.
- Parameters:
ssekmsKeyId
- If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ssekmsEncryptionContext
CopyObjectResponse.Builder ssekmsEncryptionContext(String 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.
This functionality is not supported for directory buckets.
- Parameters:
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.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucketKeyEnabled
CopyObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
- Parameters:
bucketKeyEnabled
- Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestCharged
CopyObjectResponse.Builder requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
requestCharged
CopyObjectResponse.Builder requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
-