Skip to content

GCP: Fix GCSInputStream Javadoc describing streaming uploads#17273

Draft
thswlsqls wants to merge 1 commit into
apache:mainfrom
thswlsqls:docs/gcs-inputstream-javadoc-downloads
Draft

GCP: Fix GCSInputStream Javadoc describing streaming uploads#17273
thswlsqls wants to merge 1 commit into
apache:mainfrom
thswlsqls:docs/gcs-inputstream-javadoc-downloads

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Summary

  • GCSInputStream is read-only: it extends SeekableInputStream, implements RangeReadable, and only opens a ReadChannel via storage.reader(). Its class Javadoc described it as being for "streaming uploads", and the old link resolves to the upload docs (/storage/docs/uploads).
  • The wording was copied from GCSOutputStream, added in the same commit (Add FileIO implementation for Google Cloud Storage #3711), where "uploads" is correct — so GCSOutputStream is left untouched.
  • Changed the text to "streaming downloads" and the link to https://cloud.google.com/storage/docs/streaming-downloads, whose title matches the anchor text.

Testing done

  • Javadoc wording only, no behavior change — no test added. ./gradlew :iceberg-gcp:spotlessCheck passed.

GCSInputStream is a read-only stream: it extends SeekableInputStream,
implements RangeReadable, and only ever opens a ReadChannel through
storage.reader(). Its class Javadoc described it as being for streaming
uploads and linked to the upload docs page. The wording was copied from
GCSOutputStream, which was added in the same commit (apache#3711) and where
"uploads" is correct.

Point the text and the link at streaming downloads instead.

Generated-by: Claude Code
@github-actions github-actions Bot added the GCP label Jul 17, 2026
@thswlsqls
thswlsqls marked this pull request as draft July 17, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant