Setting metadata and retention with UploadDirectoryRequest

[Se7enShawn]

Describe the feature

I need set tagging, metadata and retention when uploading a directory with transfer manager

Use Case

This code not work, because applyMutation work on a new putObjectRequest and not on the builder autogenerated by the UploadDirectoryRequest

UploadDirectoryRequest uploadDirectoryRequest = UploadDirectoryRequest.builder()
  .source(sourceDirectory)
  .bucket(bucketName)
  .s3Prefix(prefix)
  .uploadFileRequestTransformer(request -> request
		.putObjectRequest(porb -> porb
			    .applyMutation(builder -> builder
			                .tagging(Tagging.builder().tagSet(tags).build())
			                .metadata(metadata)
			                .objectLockLegalHoldStatus(ObjectLockLegalHoldStatus.ON)
			                .objectLockMode(ObjectLockMode.COMPLIANCE)
			                .objectLockRetainUntilDate(retention)))
		  .addTransferListener(LoggingTransferListener.create()))
  .build();

Proposed Solution

Add a method putObjectRequestTransformer on UploadDirectoryRequest and/or update UploadDirectoryHelper to work correctly with mutation.
Currently UploadDirectoryHelper build PutObjectRequest before uploadFileRequestTransformer:

PutObjectRequest putObjectRequest = PutObjectRequest.builder()
  .bucket(uploadDirectoryRequest.bucket())
  .key(key)
  .build();

UploadFileRequest.Builder requestBuilder = UploadFileRequest.builder()
  .source(path)
  .putObjectRequest(putObjectRequest);

uploadDirectoryRequest.uploadFileRequestTransformer().accept(requestBuilder);

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS Java SDK version used

2.25.64

JDK version used

openjdk version "17.0.11" 2024-04-16 LTS

Operating System and version

Windows 11

[debora-ito]

@Se7enShawn the following example should work:

        DirectoryUpload upload = s3TransferManager.uploadDirectory(
            UploadDirectoryRequest.builder()
                .source(Paths.get("/Users/me/sourceDirectory"))
                .bucket(BUCKET)
                .s3Prefix(PREFIX)
                .s3Delimiter(DELIMITER)
                .uploadFileRequestTransformer(uftransformer -> {
                    var originalRequest = uftransformer.build().putObjectRequest();
                    
                    uftransformer.putObjectRequest(r -> r.bucket(originalRequest.bucket())
                                    .key(originalRequest.key())
                                    .tagging(Tagging.builder().tagSet(t->t.key("myTag").value("123")).build())
                                    .metadata(Map.of("foo", "metafoo"))
                                    .objectLockMode(ObjectLockMode.COMPLIANCE)
                                    .objectLockLegalHoldStatus(ObjectLockLegalHoldStatus.ON)
                                    .objectLockRetainUntilDate(retention))
                            .build();
                })
                .build()
        );

Let us know if you have follow-up questions.