Add more detailed javadoc to Blob and Storage signUrl #743

mziccard · 2016-03-11T17:56:17Z

This follows from #739 and tries to add a better javadoc to Storage.signUrl and Blob.signUrl

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Blob.java

+   * and its associated key. If a {@link AuthCredentials.ServiceAccountAuthCredentials} was passed
+   * to {@link StorageOptions.Builder#authCredentials(AuthCredentials)} or the default credentials
+   * are being used and the environment variable {@code GOOGLE_APPLICATION_CREDENTIALS} is set, then
+   * {@code signUrl} will use that service account and associated key to sign the URL. If this


ajkannan · 2016-03-11T18:22:45Z

Thanks for taking this issue! Just a few nits from me.

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Blob.java

@@ -456,13 +457,40 @@ public WriteChannel writer(BlobWriteOption... options) {
   * Generates a signed URL for this blob. If you want to allow access to for a fixed amount of time


aozarov · 2016-03-11T19:04:44Z

Great. +1 for @ajkannan point about making the order clear. @OverclockedTim is that clear enough?

OverclockedTim · 2016-03-11T19:13:46Z

This is definitely looking great, very helpful. Would you guys consider adding a comment similar to what @mziccard mentioned in #739: "Signing a URL involves signing with a private key. If the credentials used to authenticate do not expose one (this is the case for App Engine credentials, Compute Engine credentials and Google Cloud SDK credentials) there is nothing we can do to help."? That was the most helpful line for me personally, since I did not previously realize that those credential types didn't contain the necessary private keys.

aozarov · 2016-03-11T19:18:17Z

Yes, that is a good idea. Though I think we should direct that statement in the fallback option when serviceAccount is not set.

mziccard · 2016-03-13T11:14:29Z

I rephrased javadoc to address @ajkannan and @OverclockedTim comments.

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Blob.java

-   * want to require users to explicitly log in.
+   * Generates a signed URL for this blob. If you want to allow access for a fixed amount of time to
+   * this blob, you can use this method to generate a URL that is only valid within a certain time
+   * period. This is particularly useful if you don't want publicly accessible blobs, but don't want


aozarov · 2016-03-14T21:10:49Z

Looks good. Feel free to merge with or without my suggestions.

mziccard · 2016-03-15T13:49:35Z

Comments fixed. Merging!

Add more detailed javadoc to Blob and Storage signUrl

* chore: Integrate new gapic-generator-java and rules_gapic PiperOrigin-RevId: 454027580 Source-Link: googleapis/googleapis@1b22277 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e04cea20d0d12eb5c3bdb360a9e72b654edcb638 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTA0Y2VhMjBkMGQxMmViNWMzYmRiMzYwYTllNzJiNjU0ZWRjYjYzOCJ9 chore: include generated samples dir PiperOrigin-RevId: 450696442 Source-Link: googleapis/googleapis@da052c9 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4800d1f2ea50e2cad9ce78b34185e9577029db5c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDgwMGQxZjJlYTUwZTJjYWQ5Y2U3OGIzNDE4NWU5NTc3MDI5ZGI1YyJ9 chore(deps): upgrade gapic-generator-java to 2.8.0 and update gax-java to 2.18.1 PiperOrigin-RevId: 450543911 Source-Link: googleapis/googleapis@5528344 Source-Link: https://github.com/googleapis/googleapis-gen/commit/9f6775cab1958982b88967a43e5e806af0f135db Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWY2Nzc1Y2FiMTk1ODk4MmI4ODk2N2E0M2U1ZTgwNmFmMGYxMzVkYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

🤖 I have created a release *beep* *boop* --- ### [1.2.7](googleapis/java-resourcemanager@v1.2.6...v1.2.7) (2022-03-29) ### Dependencies * update dependency com.google.cloud:google-cloud-shared-dependencies to v2.9.0 ([googleapis#743](googleapis/java-resourcemanager#743)) ([3a7e696](googleapis/java-resourcemanager@3a7e696)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

…onfig to v1.5.0 (googleapis#743) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-shared-config](https://togithub.com/googleapis/java-shared-config) | `1.4.0` -> `1.5.0` | [![age](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-shared-config/1.5.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-shared-config/1.5.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-shared-config/1.5.0/compatibility-slim/1.4.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-shared-config/1.5.0/confidence-slim/1.4.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. ⚠ **Warning**: custom changes will be lost. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-container).

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

…udgets to v2.3.2 (#743) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-billingbudgets](https://togithub.com/googleapis/java-billingbudgets) | `2.3.0` -> `2.3.2` | [![age](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-billingbudgets/2.3.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-billingbudgets/2.3.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-billingbudgets/2.3.2/compatibility-slim/2.3.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/maven/com.google.cloud:google-cloud-billingbudgets/2.3.2/confidence-slim/2.3.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. ⚠ **Warning**: custom changes will be lost. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-billingbudgets).

🤖 I have created a release *beep* *boop* --- ## [2.5.2](googleapis/java-bigqueryconnection@v2.5.1...v2.5.2) (2022-09-09) ### Dependencies * Update dependency com.google.cloud:google-cloud-shared-dependencies to v3.0.2 ([#742](googleapis/java-bigqueryconnection#742)) ([a41bac5](googleapis/java-bigqueryconnection@a41bac5)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

…ements.txt (#743) * chore: update pip install statements in release scripts to use requirements.txt file

…thon 3.6 (#1588)" (#743) Reverts googleapis/java-bigqueryreservation#718

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

…s#1687) (googleapis#743) * chore(java): add a note in README for migrated split repos Disable renovate bot and flaky bot for split repositories that have moved to the Java monorepo. The Java monorepo will pass the "monorepo=True" parameter to java.common_templates method in its owlbot.py files so that the migration note will not appear in the README in the monorepo. Co-authored-by: Jeff Ching <chingor@google.com> Source-Link: https://togithub.com/googleapis/synthtool/commit/d4b291604f148cde065838c498bc8aa79b8dc10e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:edae91ccdd2dded2f572ec341a768ad180305a3e8fbfd93064b28e237d35920a

🤖 I have created a release *beep* *boop* --- ### [2.5.6](googleapis/java-core@v2.5.5...v2.5.6) (2022-03-01) ### Dependencies * update dependency com.google.api.grpc:proto-google-iam-v1 to v1.2.6 ([#742](googleapis/java-core#742)) ([a96416b](googleapis/java-core@a96416b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Add more detailed javadoc to Blob and Storage signUrl

ac1ba66

mziccard added the docs label Mar 11, 2016

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 11, 2016

ajkannan reviewed Mar 11, 2016
View reviewed changes

aozarov reviewed Mar 11, 2016
View reviewed changes

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Blob.java

@@ -456,13 +457,40 @@ public WriteChannel writer(BlobWriteOption... options) {

* Generates a signed URL for this blob. If you want to allow access to for a fixed amount of time

This comment was marked as spam.

Sign in to view

Rephrase signUrl javadoc for better clarity

ddb1ade

aozarov reviewed Mar 14, 2016
View reviewed changes

Add better javadoc for signUrl examples

4e0248f

mziccard added a commit that referenced this pull request Mar 15, 2016

Merge pull request #743 from mziccard/signurl-javadoc

3b083a6

Add more detailed javadoc to Blob and Storage signUrl

mziccard merged commit 3b083a6 into googleapis:master Mar 15, 2016

mziccard mentioned this pull request Mar 15, 2016

Possible Gcloud Java bug in signurl? #739

Closed

github-actions bot pushed a commit that referenced this pull request Sep 16, 2022

chore: update pip install statements in release scripts to use requir…

4474864

…ements.txt (#743) * chore: update pip install statements in release scripts to use requirements.txt file

github-actions bot pushed a commit that referenced this pull request Sep 30, 2022

Revert "chore: pin versions of dependencies for compatibility with Py…

b9bcb76

…thon 3.6 (#1588)" (#743) Reverts googleapis/java-bigqueryreservation#718

suztomo pushed a commit that referenced this pull request Feb 1, 2023

deps: update iam.version to v1.5.2 (#743)

294ea85

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more detailed javadoc to Blob and Storage signUrl #743

Add more detailed javadoc to Blob and Storage signUrl #743

mziccard commented Mar 11, 2016

This comment was marked as spam.

ajkannan commented Mar 11, 2016

This comment was marked as spam.

aozarov commented Mar 11, 2016

OverclockedTim commented Mar 11, 2016

aozarov commented Mar 11, 2016

mziccard commented Mar 13, 2016

This comment was marked as spam.

aozarov commented Mar 14, 2016

mziccard commented Mar 15, 2016

		@@ -456,13 +457,40 @@ public WriteChannel writer(BlobWriteOption... options) {
		* Generates a signed URL for this blob. If you want to allow access to for a fixed amount of time

Add more detailed javadoc to Blob and Storage signUrl #743

Add more detailed javadoc to Blob and Storage signUrl #743

Conversation

mziccard commented Mar 11, 2016

This comment was marked as spam.

ajkannan commented Mar 11, 2016

This comment was marked as spam.

aozarov commented Mar 11, 2016

OverclockedTim commented Mar 11, 2016

aozarov commented Mar 11, 2016

mziccard commented Mar 13, 2016

This comment was marked as spam.

aozarov commented Mar 14, 2016

mziccard commented Mar 15, 2016