Skip to content

Update java doc on ContentLength in requestBody for s3 uploads #6051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 23, 2025

Conversation

Fred1155
Copy link
Contributor

Motivation and Context

Customers may get partial object puts when they SDK to upload an input stream, but they incorrectly set the content length. This PR improved the documentation surrounding this usage to warn user from inadvertently setting an incorrect Content-Length.

Modifications

Added documentation in

AsyncRequestBody.fromInputStream
AsyncRequestBody.forBlockingInputStream
AsyncRequestBody.forBlockingOutputStream
RequestBody.fromInputStream
RequestBody.fromContentProvider

Testing

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 added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • 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

@Fred1155 Fred1155 requested a review from a team as a code owner April 22, 2025 21:09
@Fred1155 Fred1155 enabled auto-merge April 22, 2025 22:30
@Fred1155 Fred1155 added this pull request to the merge queue Apr 23, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 23, 2025
@Fred1155 Fred1155 added this pull request to the merge queue Apr 23, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 23, 2025
@Fred1155 Fred1155 added this pull request to the merge queue Apr 23, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 23, 2025
@Fred1155 Fred1155 added this pull request to the merge queue Apr 23, 2025
github-merge-queue bot pushed a commit that referenced this pull request Apr 23, 2025
* Java doc related to contentLength updated

* doc updated

* doc updated

* deleted unnecessary test
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 23, 2025
@Fred1155 Fred1155 added this pull request to the merge queue Apr 23, 2025
Merged via the queue into master with commit 157f16c Apr 23, 2025
19 checks passed
@Fred1155 Fred1155 deleted the bole/update_content_length_doc branch April 23, 2025 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants