Add AsyncRequestBody#fromInputStream(AsyncRequestBodyFromInputStreamC… #4643
Conversation
This file contains 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
zoewangg
commented
Oct 27, 2023
| * should create an {@link AsyncRequestBody} from an {@link InputStream}. | ||
| */ | ||
| @SdkPublicApi | ||
| public final class AsyncRequestBodyFromInputStreamConfiguration implements ToCopyableBuilder<AsyncRequestBodyFromInputStreamConfiguration.Builder, |
There was a problem hiding this comment.
This is a bit mouthful, lmk if you have better ideas.
| * effect if the stream doesn't support mark and reset. | ||
| * | ||
| * <p> | ||
| * By default, it is 128 KiB. |
There was a problem hiding this comment.
Alternatively, we could make it contentLength + 1 so that users don't have to configure it by themselves, however, this would mean it may buffer all the data, so I'm reluctant to make this the default behavior.
…onfiguration) to allow users to specify the max read limit on the InputStream
zoewangg
force-pushed
the
zoewang/allowReadLimitConfiguration
branch
from
dee8d64
to
7c04729
Compare
davidh44
approved these changes
Oct 30, 2023
|
Kudos, SonarCloud Quality Gate passed! |
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.
…onfiguration) to allow users to specify the max read limit on the InputStream
Motivation and Context
Transient network error is not uncommon when customers upload objects of a larger size to S3 and those failed requests would normally succeed upon retry. However, if users use
AsyncRequestBodyFromInputStreamas theAsyncRequestBodyand the stream is larger than the default mark value, the SDK may not be able to retry the request in the event of network issue. This is because the default read limit of the provided inputStream used for mark and reset is 128KB.Related to aws/aws-sdk-java#427
Notes:
This option is exposed in v1 via RequestClientOptions#setReadLimit. I did not include this in the ReqeustOverrideConfiguration because this only applies to
InputStreamonly.This is technically possible to do in
RequestBody, (RequestBody#fromContentProvider), that's why I didn't make the change in RequestBodyModifications
Add
AsyncRequestBody#fromInputStream(AsyncRequestBodyFromInputStreamConfiguration)that allow users to configure max read limit.Testing
Added unit tests
Screenshots (if appropriate)
Types of changes
Checklist
mvn installsucceedsscripts/new-changescript and following the instructions. Commit the new file created by the script in.changes/next-releasewith your changes.License