New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

fix: Blob API Doc is confusing #233

Merged

frankyn merged 5 commits into googleapis:master from dmitry-fa:BlobDoc

Apr 14, 2020

Contributor

dmitry-fa commented Apr 8, 2020

Fixes #176

dmitry-fa added 2 commits

April 8, 2020 16:40


          fix: blob api doc is confusing

ce34eb4


          fix: blob api doc is confusing

bec01a3

googlebot added the cla: yes label

codecov bot commented Apr 8, 2020 •

edited

Loading

Codecov Report

Merging #233 into master will decrease coverage by 0.06%.
The diff coverage is n/a.

@@             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

Impacted Files	Coverage Δ	Complexity Δ
...e/src/main/java/com/google/cloud/storage/Blob.java	`81.97% <ø> (ø)`	`29.00 <0.00> (ø)`
...c/main/java/com/google/cloud/storage/BlobInfo.java	`88.95% <ø> (ø)`	`88.00 <0.00> (ø)`
...gle/cloud/storage/testing/RemoteStorageHelper.java	`61.47% <0.00%> (-2.46%)`	`9.00% <0.00%> (ø%)`

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 397fcd9...4d37e98. Read the comment docs.

dmitry-fa requested review from elharo and frankyn

April 8, 2020 15:28

elharo reviewed

View reviewed changes

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

+               * 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

elharo Apr 8, 2020

Operations that access the content issue...

Contributor Author

dmitry-fa Apr 8, 2020

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


          fix: blob api doc is confusing

a49ac68

elharo reviewed

View reviewed changes

google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java Outdated

@@ @@ -52,12 +52,26 @@ @@
               import java.util.concurrent.TimeUnit;
               /**
-               * A Google cloud storage object.
+               * A Google cloud storage object. A {@code Blob} object includes the {@code BlobId} instance, the

Contributor

elharo Apr 9, 2020

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. :-(

Contributor Author

dmitry-fa Apr 9, 2020

agree

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


          fix: blob api doc is confusing

754c6c8

dmitry-fa mentioned this pull request

fix: deprecate Blob.update() and modify documentation of Storage.update methods #236

Closed

dmitry-fa added the kokoro:force-run label

yoshi-kokoro removed the kokoro:force-run label


          fix: deprecate blob.update() and modify documentation of storage.upda…

4d37e98

…te() methods

elharo approved these changes

View reviewed changes

google-cloud-storage/src/main/java/com/google/cloud/storage/BlobInfo.java Outdated

+               * 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:

Contributor

elharo Apr 13, 2020

crate --> create

Contributor Author

dmitry-fa Apr 13, 2020

Thanks a lot!

frankyn approved these changes

View reviewed changes

Contributor

frankyn left a comment

LGTM

frankyn merged commit b5208b8 into googleapis:master

dmitry-fa deleted the BlobDoc branch

June 26, 2020 07:34

# for free to join this conversation on GitHub. Already have an account? # to comment

Labels