docs: document differing behavior of {get,list}{,default}Acl between …

…HTTP and gRPC (#1820) Update ITAccessTest to run UBLA and IAM centric tests for gRPC. Split iam v1 and iam v3 tests out from ITAccessTest to ITBucketIamPolicyTest making them hermetic.
googleapis · Jan 4, 2023 · 9511b17 · 9511b17
1 parent 0665c24
commit 9511b17
Show file tree

Hide file tree

Showing 3 changed files with 305 additions and 399 deletions.
diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java
@@ -3363,6 +3363,16 @@ PostPolicyV4 generateSignedPostPolicyV4(
    * Acl acl = storage.getAcl(bucketName, new User(userEmail), userProjectOption);
    * }</pre>
    *
+   * <h4>Behavioral Differences between HTTP and gRPC</h4>
+   *
+   * <ol>
+   *   <li>Calling this method for a Bucket which has <a target="_blank" rel="noopener noreferrer"
+   *       href="https://cloud.google.com/storage/docs/uniform-bucket-level-access">Uniform
+   *       bucket-level access</a> enabled exhibits different behavior Depending on which {@link
+   *       Transport} is used. For JSON, an HTTP 400 Bad Request error will be thrown. Whereas for
+   *       gRPC, an empty list will be returned.
+   * </ol>
+   *
    * @param bucket name of the bucket where the getAcl operation takes place
    * @param entity ACL entity to fetch
    * @param options extra parameters to apply to this operation
@@ -3496,6 +3506,16 @@ PostPolicyV4 generateSignedPostPolicyV4(
    * }
    * }</pre>
    *
+   * <h4>Behavioral Differences between HTTP and gRPC</h4>
+   *
+   * <ol>
+   *   <li>Calling this method for a Bucket which has <a target="_blank" rel="noopener noreferrer"
+   *       href="https://cloud.google.com/storage/docs/uniform-bucket-level-access">Uniform
+   *       bucket-level access</a> enabled exhibits different behavior Depending on which {@link
+   *       Transport} is used. For JSON, an HTTP 400 Bad Request error will be thrown. Whereas for
+   *       gRPC, an empty list will be returned.
+   * </ol>
+   *
    * @param bucket the name of the bucket to list ACLs for
    * @param options any number of BucketSourceOptions to apply to this operation
    * @throws StorageException upon failure
@@ -3521,6 +3541,16 @@ PostPolicyV4 generateSignedPostPolicyV4(
    * Acl acl = storage.getDefaultAcl(bucketName, User.ofAllAuthenticatedUsers());
    * }</pre>
    *
+   * <h4>Behavioral Differences between HTTP and gRPC</h4>
+   *
+   * <ol>
+   *   <li>Calling this method for a Bucket which has <a target="_blank" rel="noopener noreferrer"
+   *       href="https://cloud.google.com/storage/docs/uniform-bucket-level-access">Uniform
+   *       bucket-level access</a> enabled exhibits different behavior Depending on which {@link
+   *       Transport} is used. For JSON, an HTTP 400 Bad Request error will be thrown. Whereas for
+   *       gRPC, an empty list will be returned.
+   * </ol>
+   *
    * @throws StorageException upon failure
    */
   @TransportCompatibility({Transport.HTTP, Transport.GRPC})
@@ -3604,6 +3634,16 @@ PostPolicyV4 generateSignedPostPolicyV4(
    * }
    * }</pre>
    *
+   * <h4>Behavioral Differences between HTTP and gRPC</h4>
+   *
+   * <ol>
+   *   <li>Calling this method for a Bucket which has <a target="_blank" rel="noopener noreferrer"
+   *       href="https://cloud.google.com/storage/docs/uniform-bucket-level-access">Uniform
+   *       bucket-level access</a> enabled exhibits different behavior Depending on which {@link
+   *       Transport} is used. For JSON, an HTTP 400 Bad Request error will be thrown. Whereas for
+   *       gRPC, an empty list will be returned.
+   * </ol>
+   *
    * @throws StorageException upon failure
    */
   @TransportCompatibility({Transport.HTTP, Transport.GRPC})