docs: cleanup of Parallelstore API descriptions (#7703)

feat: add UPGRADING state to Parallelstore state PiperOrigin-RevId: 678758858 Source-Link: googleapis/googleapis@6125b3d Source-Link: googleapis/googleapis-gen@8f63dd4 Copy-Tag: eyJwIjoiUGFyYWxsZWxzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiOGY2M2RkNDUyMzA2NmEyM2Q3N2JlMjI4MDIyMzJhMjBhMjBmNjI4MSJ9
googleapis · Sep 27, 2024 · 9ed8a41 · 9ed8a41
1 parent cd47348
commit 9ed8a41
Show file tree

Hide file tree

Showing 31 changed files with 306 additions and 319 deletions.
diff --git a/Parallelstore/metadata/V1Beta/Parallelstore.php b/Parallelstore/metadata/V1Beta/Parallelstore.php
diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/create_instance.php b/Parallelstore/samples/V1beta/ParallelstoreClient/create_instance.php
@@ -35,18 +35,18 @@
  *
  * @param string $formattedParent     The instance's project and location, in the format
  *                                    `projects/{project}/locations/{location}`.
- *                                    Locations map to Google Cloud zones, for example **us-west1-b**. Please see
+ *                                    Locations map to Google Cloud zones; for example, `us-west1-b`. Please see
  *                                    {@see ParallelstoreClient::locationName()} for help formatting this field.
- * @param string $instanceId          The logical name of the Parallelstore instance in the user
- *                                    project with the following restrictions:
+ * @param string $instanceId          The name of the Parallelstore instance.
  *
  *                                    * Must contain only lowercase letters, numbers, and hyphens.
  *                                    * Must start with a letter.
  *                                    * Must be between 1-63 characters.
  *                                    * Must end with a number or a letter.
  *                                    * Must be unique within the customer project / location
- * @param int    $instanceCapacityGib Immutable. Storage capacity of Parallelstore instance in
- *                                    Gibibytes (GiB).
+ * @param int    $instanceCapacityGib Immutable. The instance's storage capacity in Gibibytes (GiB).
+ *                                    Allowed values are between 12000 and 100000, in multiples of 4000; e.g.,
+ *                                    12000, 16000, 20000, ...
  */
 function create_instance_sample(
     string $formattedParent,

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/delete_instance.php b/Parallelstore/samples/V1beta/ParallelstoreClient/delete_instance.php
@@ -30,7 +30,7 @@
 use Google\Rpc\Status;
 
 /**
- * Deletes a single Instance.
+ * Deletes a single instance.
  *
  * @param string $formattedName Name of the resource
  *                              Please see {@see ParallelstoreClient::instanceName()} for help formatting this field.

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/export_data.php b/Parallelstore/samples/V1beta/ParallelstoreClient/export_data.php
@@ -31,7 +31,7 @@
 use Google\Rpc\Status;
 
 /**
- * ExportData copies data from Parallelstore to Cloud Storage
+ * Copies data from Parallelstore to Cloud Storage.
  *
  * @param string $formattedName Name of the resource. Please see
  *                              {@see ParallelstoreClient::instanceName()} for help formatting this field.

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/get_instance.php b/Parallelstore/samples/V1beta/ParallelstoreClient/get_instance.php
@@ -29,7 +29,7 @@
 use Google\Cloud\Parallelstore\V1beta\Instance;
 
 /**
- * Gets details of a single Instance.
+ * Gets details of a single instance.
  *
  * @param string $formattedName The instance resource name, in the format
  *                              `projects/{project_id}/locations/{location}/instances/{instance_id}`. Please see

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/import_data.php b/Parallelstore/samples/V1beta/ParallelstoreClient/import_data.php
@@ -31,7 +31,7 @@
 use Google\Rpc\Status;
 
 /**
- * ImportData copies data from Cloud Storage to Parallelstore.
+ * Copies data from Cloud Storage to Parallelstore.
  *
  * @param string $formattedName Name of the resource. Please see
  *                              {@see ParallelstoreClient::instanceName()} for help formatting this field.

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/list_instances.php b/Parallelstore/samples/V1beta/ParallelstoreClient/list_instances.php
@@ -30,14 +30,13 @@
 use Google\Cloud\Parallelstore\V1beta\ListInstancesRequest;
 
 /**
- * Lists Instances in a given project and location.
+ * Lists all instances in a given project and location.
  *
  * @param string $formattedParent The project and location for which to retrieve instance
  *                                information, in the format `projects/{project_id}/locations/{location}`.
- *                                For Parallelstore locations map to Google Cloud zones, for example
- *                                **us-central1-a**.
- *                                To retrieve instance information for all locations, use "-" for the
- *                                `{location}` value. Please see
+ *
+ *                                To retrieve instance information for all locations, use "-" as the value of
+ *                                `{location}`. Please see
  *                                {@see ParallelstoreClient::locationName()} for help formatting this field.
  */
 function list_instances_sample(string $formattedParent): void

diff --git a/Parallelstore/samples/V1beta/ParallelstoreClient/update_instance.php b/Parallelstore/samples/V1beta/ParallelstoreClient/update_instance.php
@@ -32,10 +32,11 @@
 use Google\Rpc\Status;
 
 /**
- * Updates the parameters of a single Instance.
+ * Updates the parameters of a single instance.
  *
- * @param int $instanceCapacityGib Immutable. Storage capacity of Parallelstore instance in
- *                                 Gibibytes (GiB).
+ * @param int $instanceCapacityGib Immutable. The instance's storage capacity in Gibibytes (GiB).
+ *                                 Allowed values are between 12000 and 100000, in multiples of 4000; e.g.,
+ *                                 12000, 16000, 20000, ...
  */
 function update_instance_sample(int $instanceCapacityGib): void
 {

diff --git a/Parallelstore/src/V1beta/Client/ParallelstoreClient.php b/Parallelstore/src/V1beta/Client/ParallelstoreClient.php
@@ -422,7 +422,7 @@ public function createInstance(CreateInstanceRequest $request, array $callOption
     }
 
     /**
-     * Deletes a single Instance.
+     * Deletes a single instance.
      *
      * The async variant is {@see ParallelstoreClient::deleteInstanceAsync()} .
      *
@@ -450,7 +450,7 @@ public function deleteInstance(DeleteInstanceRequest $request, array $callOption
     }
 
     /**
-     * ExportData copies data from Parallelstore to Cloud Storage
+     * Copies data from Parallelstore to Cloud Storage.
      *
      * The async variant is {@see ParallelstoreClient::exportDataAsync()} .
      *
@@ -478,7 +478,7 @@ public function exportData(ExportDataRequest $request, array $callOptions = []):
     }
 
     /**
-     * Gets details of a single Instance.
+     * Gets details of a single instance.
      *
      * The async variant is {@see ParallelstoreClient::getInstanceAsync()} .
      *
@@ -506,7 +506,7 @@ public function getInstance(GetInstanceRequest $request, array $callOptions = []
     }
 
     /**
-     * ImportData copies data from Cloud Storage to Parallelstore.
+     * Copies data from Cloud Storage to Parallelstore.
      *
      * The async variant is {@see ParallelstoreClient::importDataAsync()} .
      *
@@ -534,7 +534,7 @@ public function importData(ImportDataRequest $request, array $callOptions = []):
     }
 
     /**
-     * Lists Instances in a given project and location.
+     * Lists all instances in a given project and location.
      *
      * The async variant is {@see ParallelstoreClient::listInstancesAsync()} .
      *
@@ -562,7 +562,7 @@ public function listInstances(ListInstancesRequest $request, array $callOptions
     }
 
     /**
-     * Updates the parameters of a single Instance.
+     * Updates the parameters of a single instance.
      *
      * The async variant is {@see ParallelstoreClient::updateInstanceAsync()} .
      *

diff --git a/Parallelstore/src/V1beta/CreateInstanceRequest.php b/Parallelstore/src/V1beta/CreateInstanceRequest.php
diff --git a/Parallelstore/src/V1beta/DeleteInstanceRequest.php b/Parallelstore/src/V1beta/DeleteInstanceRequest.php
diff --git a/Parallelstore/src/V1beta/DestinationGcsBucket.php b/Parallelstore/src/V1beta/DestinationGcsBucket.php
diff --git a/Parallelstore/src/V1beta/DestinationParallelstore.php b/Parallelstore/src/V1beta/DestinationParallelstore.php
diff --git a/Parallelstore/src/V1beta/DirectoryStripeLevel.php b/Parallelstore/src/V1beta/DirectoryStripeLevel.php