Add more options for FileAsyncResponseTransformer

[dagnir]

Description

Add the following things to control the behavior of the transformer:

• position parameter to specify where in the file to write the stream
• isNewFile parameter to specify whether this is a new file
• deleteOnFailure to specify whether the file should be deleted on failure

Motivation and Context

File opening flexibility.

Testing

Added new tests.

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist

• I have read the CONTRIBUTING document
• Local run of mvn install succeeds
• My code follows the code style of this project
• My change requires a change to the Javadoc documentation
• I have updated the Javadoc documentation accordingly
• I have read the README document
• I have added tests to cover my changes
• All new and existing tests passed
• A short description of the change has been added to the CHANGELOG
• My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

• I confirm that this pull request can be released under the Apache 2 license

[codecov-io]

Codecov Report

Merging #1222 into master will increase coverage by 0.24%.
The diff coverage is 75%.

@@             Coverage Diff              @@
##             master    #1222      +/-   ##
============================================
+ Coverage     59.02%   59.27%   +0.24%     
- Complexity     4632     4651      +19     
============================================
  Files           747      747              
  Lines         23183    23197      +14     
  Branches       1737     1738       +1     
============================================
+ Hits          13684    13749      +65     
+ Misses         8805     8743      -62     
- Partials        694      705      +11

Impacted Files	Coverage Δ	Complexity Δ
...in/java/software/amazon/awssdk/utils/Validate.java	63.15% <0%> (-1.71%)	49 <0> (ø)
...on/awssdk/core/async/AsyncResponseTransformer.java	50% <100%> (+50%)	2 <1> (+2)	⬆️
...e/internal/async/FileAsyncResponseTransformer.java	73.07% <87.5%> (+73.07%)	13 <5> (+13)	⬆️
...on/awssdk/services/kinesis/KinesisRetryPolicy.java	85.71% <0%> (ø)	2% <0%> (-1%)	⬇️
...are/amazon/awssdk/core/async/AsyncRequestBody.java	36.36% <0%> (+9.09%)	4% <0%> (+1%)	⬆️
.../netty/internal/UnusedChannelExceptionHandler.java	47.05% <0%> (+29.41%)	6% <0%> (+4%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af22896...9749ff7. Read the comment docs.

[dagnir]

Missed the default delete-on-error behavior. I'll need to fix that.

[zoewangg]

I wonder if we should use a request wrapper for this. Something like toFile(Path path, FileOption option)? My concern is that we might need to add other parameters in the future.

[dagnir]

I think in that case case a Builder might be a better option, something like

AsyncResponseTransformer.toFileTransformerBuilder()
                        .position(...)
                        .deleteOnFailure(...)
                        .build();

We have one for FileAsyncRequestBody

aws-sdk-java-v2/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/FileAsyncRequestBody.java

Line 103 in a751924

public interface Builder extends SdkBuilder<Builder, FileAsyncRequestBody> {

[zoewangg]

Like the idea of builder but I'm not sure if we want to put toFileTransformerBuilder api to AsyncResponseTransformer.

What would toFile look like? toFile(FileAsyncResponseTransformer.Builder builder)?

[dagnir]

We can probably just keep toFile(Path) as-is, since it's behavior is probably what most customers want. This extra stuff is for less common/more specialized cases I would think (such as use in the transfer manager).

[dagnir]

Closing this for now.