Skip to content

Commit

Permalink
Update signUrl documentation (googleapis#3546)
Browse files Browse the repository at this point in the history
* Removed ComputeCredentials from examples of credentials that cannot
sign URLs.
* Added a note to look at the implementations' documentation for
additional setup steps needed.
  • Loading branch information
chingor13 authored and pongad committed Sep 4, 2018
1 parent d7a135a commit c715fc6
Showing 1 changed file with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2043,10 +2043,9 @@ public static Builder newBuilder() {
* {@code GOOGLE_APPLICATION_CREDENTIALS} is set or your application is running in App Engine,
* then {@code signUrl} will use that credentials to sign the URL. If the credentials passed to
* {@link StorageOptions} do not implement {@link ServiceAccountSigner} (this is the case, for
* instance, for Compute Engine credentials and Google Cloud SDK credentials) then {@code signUrl}
* will throw an {@link IllegalStateException} unless an implementation of
* {@link ServiceAccountSigner} is passed using the
* {@link SignUrlOption#signWith(ServiceAccountSigner)} option.
* instance, for Google Cloud SDK credentials) then {@code signUrl} will throw an
* {@link IllegalStateException} unless an implementation of {@link ServiceAccountSigner} is
* passed using the {@link SignUrlOption#signWith(ServiceAccountSigner)} option.
*
* <p>A service account signer is looked for in the following order:
* <ol>
Expand Down Expand Up @@ -2076,6 +2075,9 @@ public static Builder newBuilder() {
* ServiceAccountCredentials.fromStream(new FileInputStream(keyPath))));
* }</pre>
*
* <p>Note that the {@link ServiceAccountSigner} may require additional configuration to enable
* URL signing. See the documentation for the implementation for more details.</p>
*
* @param blobInfo the blob associated with the signed URL
* @param duration time until the signed URL expires, expressed in {@code unit}. The finest
* granularity supported is 1 second, finer granularities will be truncated
Expand Down

0 comments on commit c715fc6

Please sign in to comment.