Skip to content

Commit 90db468

Browse files
danielcomptonandreamlin
authored andcommitted
Improve GCS signUrlOption javadoc (#1928)
* Improve GCS signUrlOption javadoc * Update comment for httpMethod URL signing option
1 parent ef1ccd0 commit 90db468

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

  • google-cloud-storage/src/main/java/com/google/cloud/storage

google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -893,7 +893,8 @@ Object getValue() {
893893
}
894894

895895
/**
896-
* The HTTP method to be used with the signed URL.
896+
* The HTTP method to be used with the signed URL.
897+
* If this method is not called, defaults to GET.
897898
*/
898899
public static SignUrlOption httpMethod(HttpMethod httpMethod) {
899900
return new SignUrlOption(Option.HTTP_METHOD, httpMethod.name());
@@ -902,6 +903,7 @@ public static SignUrlOption httpMethod(HttpMethod httpMethod) {
902903
/**
903904
* Use it if signature should include the blob's content-type.
904905
* When used, users of the signed URL should include the blob's content-type with their request.
906+
* If using this URL from a browser, you must include a content type that matches what the browser will send.
905907
*/
906908
public static SignUrlOption withContentType() {
907909
return new SignUrlOption(Option.CONTENT_TYPE, true);

0 commit comments

Comments
 (0)