Add support for filtering objects as part of S3 Transfer Manager's DownloadDirectory API #3042
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…wnloadDirectory API This allows users to specify a filter that will be used to evaluate which objects should be downloaded from the target S3 directory. You can use a filter, for example, to only download objects of a given size, of a given file extension, of a given last-modified date, etc. See `DownloadFilter` for some ready-made implementations. By default, if no filter is specified, all objects will be downloaded.
Bennett-Lynch
commented
Feb 18, 2022
...tom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadFilter.java
Outdated
Show resolved
Hide resolved
Bennett-Lynch
commented
Feb 18, 2022
...va/software/amazon/awssdk/transfer/s3/S3TransferManagerDownloadDirectoryIntegrationTest.java
Show resolved
Hide resolved
...tom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadFilter.java
Outdated
Show resolved
Hide resolved
zoewangg
reviewed
Feb 18, 2022
...va/software/amazon/awssdk/transfer/s3/S3TransferManagerDownloadDirectoryIntegrationTest.java
Show resolved
Hide resolved
...tom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadFilter.java
Outdated
Show resolved
Hide resolved
...tom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadFilter.java
Outdated
Show resolved
Hide resolved
...nsfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadDirectoryRequest.java
Outdated
Show resolved
Hide resolved
...nsfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DownloadDirectoryRequest.java
Show resolved
Hide resolved
cenedhryn
reviewed
Feb 18, 2022
...nager/src/main/java/software/amazon/awssdk/transfer/s3/internal/DownloadDirectoryHelper.java
Outdated
Show resolved
Hide resolved
Bennett-Lynch
commented
Feb 21, 2022
| * | ||
| * @see DownloadFilter | ||
| */ | ||
| public interface DownloadFileContext { |
There was a problem hiding this comment.
Created an interface, primarily in order to hide the constructor as an internal-API.
Alternatively, can not use an interface, but would need to expose a proper builder. Let me know if any preference.
| /** | ||
| * @return A description of the remote S3 object | ||
| */ | ||
| S3Object source(); |
There was a problem hiding this comment.
Opted to call this source so it reads symmetrical with destination.
| /** | ||
| * @return A path representing the local file destination | ||
| */ | ||
| Path destination(); |
There was a problem hiding this comment.
For now I'm proposing not including the GetObjectRequest here because I think it's unlikely to be useful. In the event we wish to add it in the future, it would be safe to add.
zoewangg
approved these changes
Feb 22, 2022
|
SonarCloud Quality Gate failed. |
aws-sdk-java-automation
added a commit
that referenced
this pull request
May 22, 2024
…648dffad6 Pull request: release <- staging/1d901610-baa2-43dc-9c6a-70c648dffad6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows users to specify a filter that will be used to evaluate which objects should be downloaded from the target S3 directory.
You can use a filter, for example, to only download objects of a given size, of a given file extension, of a given last-modified date, etc.
By default, if no filter is specified, all objects will be downloaded.
In the future, this may allow us to more easily support "sync" functionality, but support for that feature is out of scope currently.