fix: Blob API Doc is confusing#233
Merged
frankyn merged 5 commits intogoogleapis:masterfrom Apr 14, 2020
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #233 +/- ##
============================================
- Coverage 63.50% 63.43% -0.07%
Complexity 540 540
============================================
Files 30 30
Lines 4762 4762
Branches 427 427
============================================
- Hits 3024 3021 -3
- Misses 1578 1581 +3
Partials 160 160
Continue to review full report at Codecov.
|
elharo
reviewed
Apr 8, 2020
google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java
Outdated
Show resolved
Hide resolved
| * set of properties inherited from the {@link BlobInfo} class and the {@code Storage} instance. The | ||
| * class provides methods to perform operations on the object. Reading a property value does not | ||
| * issue any RPC calls. The object content is not stored within the {@code Blob} instance, | ||
| * operations on obtaining the content will issue one or multiple RPC calls, depending on the |
Contributor
There was a problem hiding this comment.
Operations that access the content issue...
Contributor
Author
There was a problem hiding this comment.
done. But access the content issue might sound confusing.
google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java
Outdated
Show resolved
Hide resolved
elharo
reviewed
Apr 9, 2020
|
|
||
| /** | ||
| * A Google cloud storage object. | ||
| * A Google cloud storage object. A {@code Blob} object includes the {@code BlobId} instance, the |
Contributor
There was a problem hiding this comment.
Be very careful with the word "object". This is very easy to confuse wit an instance of the Storage class. I suggest using the phrase "an object in Google Cloud Storage" when you mean the bytes on the server rather than "storage object" which sounds like an instance of a class.
The overloading of the word "object" is really annoying. GCS should never have called these things "objects" but that ship, I am afraid, has sailed and we can't fix it here. :-(
google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java
Outdated
Show resolved
Hide resolved
google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java
Outdated
Show resolved
Hide resolved
google-cloud-storage/src/main/java/com/google/cloud/storage/BlobInfo.java
Outdated
Show resolved
Hide resolved
google-cloud-storage/src/main/java/com/google/cloud/storage/BlobInfo.java
Outdated
Show resolved
Hide resolved
elharo
approved these changes
Apr 13, 2020
| * BlobInfo} and declares methods to perform operations on the object. Neither {@code BlobInfo} nor | ||
| * {@code Blob} instances keep the object content, just the object properties. | ||
| * | ||
| * <p>Example of usage {@code BlobInfo} to crate an object in Google Cloud Storage: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Fixes #176