User project comments (#2573)

andreamlin · web-flow · commit 2e608b89b0f7 · 2017-11-06T15:40:51.000-08:00
Addresses issue #2494. Add comments to methods that accept userProject parameter.
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
@@ -199,8 +199,8 @@ public static BucketTargetOption metagenerationNotMatch() {
     }
 
     /**
-     * Returns an option for bucket's billing user project. This option is only used by the buckets with
-     * 'requester_pays' flag.
+     * Returns an option to define the billing user project. This option is required by buckets with
+     * `requester_pays` flag enabled to assign operation costs.
      */
     @GcpLaunchStage.Alpha
     public static BucketTargetOption userProject(String userProject) {
@@ -834,8 +834,8 @@ public static BlobListOption currentDirectory() {
     }
 
     /**
-     * Returns an option for bucket's billing user project. This option is only used by the buckets with
-     * 'requester_pays' flag.
+     * Returns an option to define the billing user project. This option is required by buckets with
+     * `requester_pays` flag enabled to assign operation costs.
      *
      * @param userProject projectId of the billing user project.
      */
@@ -1389,6 +1389,9 @@ public static Builder newBuilder() {
   /**
    * Creates a new bucket.
    *
+   * Accepts an optional userProject {@link BucketTargetOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of creating a bucket.
    * <pre> {@code
    * String bucketName = "my_unique_bucket";
@@ -1432,6 +1435,8 @@ public static Builder newBuilder() {
    * Creates a new blob. Direct upload is used to upload {@code content}. For large content,
    * {@link #writer} is recommended as it uses resumable upload. MD5 and CRC32C hashes of
    * {@code content} are computed and used for validating transferred data.
+   * Accepts an optional userProject {@link BlobGetOption} option which defines the project id
+   * to assign operational costs.
    *
    * <p>Example of creating a blob from a byte array.
    * <pre> {@code
@@ -1491,6 +1496,9 @@ public static Builder newBuilder() {
   /**
    * Returns the requested bucket or {@code null} if not found.
    *
+   * Accepts an optional userProject {@link BucketGetOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of getting information on a bucket, only if its metageneration matches a value,
    * otherwise a {@link StorageException} is thrown.
    * <pre> {@code
@@ -1507,6 +1515,9 @@ public static Builder newBuilder() {
   /**
    * Returns the requested blob or {@code null} if not found.
    *
+   * Accepts an optional userProject {@link BlobGetOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of getting information on a blob, only if its metageneration matches a value,
    * otherwise a {@link StorageException} is thrown.
    * <pre> {@code
@@ -1524,6 +1535,9 @@ public static Builder newBuilder() {
   /**
    * Returns the requested blob or {@code null} if not found.
    *
+   * Accepts an optional userProject {@link BlobGetOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of getting information on a blob, only if its metageneration matches a value,
    * otherwise a {@link StorageException} is thrown.
    * <pre> {@code
@@ -1596,6 +1610,8 @@ public static Builder newBuilder() {
   /**
    * Updates bucket information.
    *
+   * Accepts an optional userProject {@link BucketTargetOption} option which defines the project id
+   * to assign operational costs.
    * <p>Example of updating bucket information.
    * <pre> {@code
    * String bucketName = "my_unique_bucket";
@@ -1612,6 +1628,8 @@ public static Builder newBuilder() {
    * Updates blob information. Original metadata are merged with metadata in the provided
    * {@code blobInfo}. To replace metadata instead you first have to unset them. Unsetting metadata
    * can be done by setting the provided {@code blobInfo}'s metadata to {@code null}.
+   * Accepts an optional userProject {@link BlobTargetOption} option which defines the project id
+   * to assign operational costs.
    *
    * <p>Example of udating a blob, only if the blob's metageneration matches a value, otherwise a
    * {@link StorageException} is thrown.
@@ -1653,6 +1671,9 @@ public static Builder newBuilder() {
   /**
    * Deletes the requested bucket.
    *
+   * Accepts an optional userProject {@link BucketSourceOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of deleting a bucket, only if its metageneration matches a value, otherwise a
    * {@link StorageException} is thrown.
    * <pre> {@code
@@ -1698,6 +1719,9 @@ public static Builder newBuilder() {
   /**
    * Deletes the requested blob.
    *
+   * Accepts an optional userProject {@link BlobSourceOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of deleting a blob, only if its generation matches a value, otherwise a
    * {@link StorageException} is thrown.
    * <pre> {@code
@@ -1742,6 +1766,9 @@ public static Builder newBuilder() {
   /**
    * Sends a compose request.
    *
+   * Accepts an optional userProject {@link BlobTargetOption} option which defines the project id
+   * to assign operational costs.
+   *
    * <p>Example of composing two blobs.
    * <pre> {@code
    * String bucketName = "my_unique_bucket";
