Skip to content
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

Blob API Doc is confusing #176

Closed
elharo opened this issue Mar 12, 2020 · 0 comments · Fixed by #233
Closed

Blob API Doc is confusing #176

elharo opened this issue Mar 12, 2020 · 0 comments · Fixed by #233
Assignees
Labels
api: storage Issues related to the googleapis/java-storage API. semver: patch A minor bug fix or small change. type: docs Improvement to the documentation for an API.

Comments

@elharo
Copy link
Contributor

elharo commented Mar 12, 2020

I'm not sure if the issue is the docs, the API design, or both. However I'm having real trouble understanding the API of this class.

In particular I'm confused about what Blob objects are and what they represent. On the one hand "A Google cloud storage object." On the other hand these objects are immutable and provide methods to modify the blob on GCS which return new Blob objects.

I suspect the Javadoc is having trouble distinguishing an object that points to the thing from the thing itself.

A Google cloud storage object.

Objects of this class are immutable. Operations that modify the blob like update(com.google.cloud.storage.Storage.BlobTargetOption...) and copyTo(com.google.cloud.storage.BlobId, com.google.cloud.storage.Blob.BlobSourceOption...) return a new object. To get a Blob object with the most recent information use reload(com.google.cloud.storage.Blob.BlobSourceOption...). Blob adds a layer of service-related functionality over BlobInfo.

@elharo elharo added type: docs Improvement to the documentation for an API. semver: patch A minor bug fix or small change. labels Mar 12, 2020
@product-auto-label product-auto-label bot added the api: storage Issues related to the googleapis/java-storage API. label Mar 12, 2020
@elharo elharo changed the title Blob jvaDoc is confusing Blob API Doc is confusing Mar 12, 2020
@dmitry-fa dmitry-fa self-assigned this Apr 3, 2020
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. semver: patch A minor bug fix or small change. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants