KEMBAR78
Blob API Doc is confusing · Issue #176 · googleapis/java-storage · GitHub
Skip to content

Blob API Doc is confusing #176

@elharo

Description

@elharo

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.

Metadata

Metadata

Assignees

Labels

api: storageIssues related to the googleapis/java-storage API.semver: patchA minor bug fix or small change.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions