-
Notifications
You must be signed in to change notification settings - Fork 77
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
docs: Javadocs for TransferManager interface and ParallelUploadConfig #2094
Merged
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
product-auto-label
bot
added
size: m
Pull request size is medium.
api: storage
Issues related to the googleapis/java-storage API.
labels
Jun 23, 2023
frankyn
approved these changes
Jun 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just had one q which is from me not remember javadoc;
...oud-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelUploadConfig.java
Show resolved
Hide resolved
BenWhitehead
requested changes
Jun 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I'd like to see the
@see
cross links on the builder setters/config getters. - Adding a note to uploadFiles/downloadBlobs to note they do not block the invoking thread waiting for all the work to complete.
- A few nits/alternative pharasings - if you feel these don't clarify anything feel free to ignore.
...d-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelDownloadConfig.java
Outdated
Show resolved
Hide resolved
...d-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelDownloadConfig.java
Show resolved
Hide resolved
...d-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelDownloadConfig.java
Show resolved
Hide resolved
...oud-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelUploadConfig.java
Outdated
Show resolved
Hide resolved
...oud-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelUploadConfig.java
Outdated
Show resolved
Hide resolved
...oud-storage/src/main/java/com/google/cloud/storage/transfermanager/ParallelUploadConfig.java
Show resolved
Hide resolved
...le-cloud-storage/src/main/java/com/google/cloud/storage/transfermanager/TransferManager.java
Show resolved
Hide resolved
…ansfermanager/ParallelDownloadConfig.java Co-authored-by: BenWhitehead <[email protected]>
Co-authored-by: BenWhitehead <[email protected]>
…ansfermanager/ParallelUploadConfig.java Co-authored-by: BenWhitehead <[email protected]>
BenWhitehead
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
api: storage
Issues related to the googleapis/java-storage API.
size: m
Pull request size is medium.
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.
First commit for Javadocs. Will continue to add files as I write them but wanted to get initial feedback to ensure this is the direction we would like the javadocs to go and they are clear.