chore(storage): move commented example value to docblocks in Storage samples (#1715)

Author: ajupazhamayil

storage/src/activate_hmac_key.php

@@ -30,13 +30,12 @@
  * Activate an HMAC key.
  *
  * @param string $projectId The ID of your Google Cloud Platform project.
+ *        (e.g. 'my-project-id')
  * @param string $accessId Access ID for an inactive HMAC key.
+ *        (e.g. 'GOOG0234230X00')
  */
 function activate_hmac_key(string $projectId, string $accessId): void
 {
-    // $projectId = 'my-project-id';
-    // $accessId = 'GOOG0234230X00';
-
     $storage = new StorageClient();
     // By default hmacKey will use the projectId used by StorageClient().
     $hmacKey = $storage->hmacKey($accessId, $projectId);

storage/src/add_bucket_acl.php

@@ -30,15 +30,14 @@
  * Add an entity and role to a bucket's ACL.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $entity The entity for which to update access controls.
+ *        (e.g. 'user-example@domain.com')
  * @param string $role The permissions to add for the specified entity.
+ *        (e.g. 'OWNER')
  */
 function add_bucket_acl(string $bucketName, string $entity, string $role): void
 {
-    // $bucketName = 'my-bucket';
-    // $entity = 'user-example@domain.com';
-    // $role = 'OWNER';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
     $acl = $bucket->acl();

storage/src/add_bucket_conditional_iam_binding.php

@@ -30,24 +30,22 @@
  * Adds a conditional IAM binding to a bucket's IAM policy.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $role The role that will be given to members in this binding.
+ *        (e.g. 'roles/storage.objectViewer')
  * @param string[] $members The member(s) associated with this binding.
- * @param string $title The title of the condition.
+ *        (e.g. ['group:example@google.com'])
+ * @param string $title The title of the condition. (e.g. 'Title')
  * @param string $description The description of the condition.
+ *        (e.g. 'Condition Description')
  * @param string $expression The condition specified in CEL expression language.
+ *        (e.g. 'resource.name.startsWith("projects/_/buckets/bucket-name/objects/prefix-a-")')
  *
  * To see how to express a condition in CEL, visit:
  * @see https://cloud.google.com/storage/docs/access-control/iam#conditions.
  */
 function add_bucket_conditional_iam_binding(string $bucketName, string $role, array $members, string $title, string $description, string $expression): void
 {
-    // $bucketName = 'my-bucket';
-    // $role = 'roles/storage.objectViewer';
-    // $members = ['group:example@google.com'];
-    // $title = 'Title';
-    // $description = 'Condition Description';
-    // $expression = 'resource.name.startsWith("projects/_/buckets/bucket-name/objects/prefix-a-")';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
 

storage/src/add_bucket_default_acl.php

@@ -30,15 +30,14 @@
  * Add an entity and role to a bucket's default ACL.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $entity The entity for which to update access controls.
+ *        (e.g. 'user-example@domain.com')
  * @param string $role The permissions to add for the specified entity.
+ *        (e.g. 'OWNER')
  */
 function add_bucket_default_acl(string $bucketName, string $entity, string $role): void
 {
-    // $bucketName = 'my-bucket';
-    // $entity = 'user-example@domain.com';
-    // $role = 'OWNER';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
     $acl = $bucket->defaultAcl();

storage/src/add_bucket_iam_member.php

@@ -30,15 +30,14 @@
  * Adds a new member / role IAM pair to a given Cloud Storage bucket.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $role The role to which the given member should be added.
+ *        (e.g. 'roles/storage.objectViewer')
  * @param string[] $members The member(s) to be added to the role.
+ *        (e.g. ['group:example@google.com'])
  */
 function add_bucket_iam_member(string $bucketName, string $role, array $members): void
 {
-    // $bucketName = 'my-bucket';
-    // $role = 'roles/storage.objectViewer';
-    // $members = ['group:example@google.com'];
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
 

storage/src/add_bucket_label.php

@@ -30,15 +30,14 @@
  * Adds or updates a bucket label.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $labelName The name of the label to add.
+ *        (e.g. 'label-key-to-add')
  * @param string $labelValue The value of the label to add.
+ *        (e.g. 'label-value-to-add')
  */
 function add_bucket_label(string $bucketName, string $labelName, string $labelValue): void
 {
-    // $bucketName = 'my-bucket';
-    // $labelName = 'label-key-to-add';
-    // $labelValue = 'label-value-to-add';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
     $newLabels = [$labelName => $labelValue];

storage/src/add_object_acl.php

@@ -30,17 +30,16 @@
  * Add an entity and role to an object's ACL.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $objectName The name of your Cloud Storage object.
+ *        (e.g. 'my-object')
  * @param string $entity The entity for which to update access controls.
+ *        (e.g. 'user-example@domain.com')
  * @param string $role The permissions to add for the specified entity.
+ *        (e.g. 'OWNER')
  */
 function add_object_acl(string $bucketName, string $objectName, string $entity, string $role): void
 {
-    // $bucketName = 'my-bucket';
-    // $objectName = 'my-object';
-    // $entity = 'user-example@domain.com';
-    // $role = 'OWNER';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
     $object = $bucket->object($objectName);

storage/src/bucket_delete_default_kms_key.php

@@ -30,11 +30,10 @@
  * Delete the default KMS key on the given bucket.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  */
 function bucket_delete_default_kms_key(string $bucketName): void
 {
-    // $bucketName = 'my-bucket';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
 

storage/src/change_default_storage_class.php

@@ -30,11 +30,10 @@
  * Change the default storage class for the given bucket.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  */
 function change_default_storage_class(string $bucketName): void
 {
-    // $bucketName = 'my-bucket';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
 

storage/src/change_file_storage_class.php

@@ -30,15 +30,14 @@
  * Change the storage class of the given file.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
  * @param string $objectName The name of your Cloud Storage object.
+ *        (e.g. 'my-object')
  * @param string $storageClass The storage class of the new object.
+ *        (e.g. 'COLDLINE')
  */
 function change_file_storage_class(string $bucketName, string $objectName, string $storageClass): void
 {
-    // $bucketName = 'my-bucket';
-    // $objectName = 'my-object';
-    // $storageClass = 'COLDLINE';
-
     $storage = new StorageClient();
     $bucket = $storage->bucket($bucketName);
     $object = $bucket->object($objectName);