feat: update generated clients (#2473)

* [CHANGE ME] Re-generated Spanner to pick up changes in the API or client library generator. * fix breaking change with synth magic
googleapis · Nov 18, 2019 · e44252c · e44252c
1 parent 0f4b19c
commit e44252c
Show file tree

Hide file tree

Showing 36 changed files with 1,161 additions and 790 deletions.
diff --git a/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php b/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php
diff --git a/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php b/Spanner/src/Admin/Database/V1/CreateDatabaseRequest.php
diff --git a/Spanner/src/Admin/Database/V1/DatabaseAdminGrpcClient.php b/Spanner/src/Admin/Database/V1/DatabaseAdminGrpcClient.php
@@ -57,8 +57,8 @@ public function ListDatabases(\Google\Cloud\Spanner\Admin\Database\V1\ListDataba
      * have a name of the format `<database_name>/operations/<operation_id>` and
      * can be used to track preparation of the database. The
      * [metadata][google.longrunning.Operation.metadata] field type is
-     * [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
-     * [response][google.longrunning.Operation.response] field type is
+     * [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata].
+     * The [response][google.longrunning.Operation.response] field type is
      * [Database][google.spanner.admin.database.v1.Database], if successful.
      * @param \Google\Cloud\Spanner\Admin\Database\V1\CreateDatabaseRequest $argument input argument
      * @param array $metadata metadata
@@ -93,7 +93,8 @@ public function GetDatabase(\Google\Cloud\Spanner\Admin\Database\V1\GetDatabaseR
      * the format `<database_name>/operations/<operation_id>` and can be used to
      * track execution of the schema change(s). The
      * [metadata][google.longrunning.Operation.metadata] field type is
-     * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].  The operation has no response.
+     * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].
+     * The operation has no response.
      * @param \Google\Cloud\Spanner\Admin\Database\V1\UpdateDatabaseDdlRequest $argument input argument
      * @param array $metadata metadata
      * @param array $options call options

diff --git a/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php b/Spanner/src/Admin/Database/V1/DropDatabaseRequest.php
diff --git a/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php b/Spanner/src/Admin/Database/V1/Gapic/DatabaseAdminGapicClient.php
@@ -71,21 +71,35 @@
  * $databaseAdminClient = new DatabaseAdminClient();
  * try {
  *     $formattedParent = $databaseAdminClient->instanceName('[PROJECT]', '[INSTANCE]');
- *     // Iterate over pages of elements
- *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
- *     foreach ($pagedResponse->iteratePages() as $page) {
- *         foreach ($page as $element) {
- *             // doSomethingWith($element);
- *         }
+ *     $createStatement = '';
+ *     $operationResponse = $databaseAdminClient->createDatabase($formattedParent, $createStatement);
+ *     $operationResponse->pollUntilComplete();
+ *     if ($operationResponse->operationSucceeded()) {
+ *         $result = $operationResponse->getResult();
+ *         // doSomethingWith($result)
+ *     } else {
+ *         $error = $operationResponse->getError();
+ *         // handleError($error)
  *     }
  *
  *
  *     // Alternatively:
  *
- *     // Iterate through all elements
- *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
- *     foreach ($pagedResponse->iterateAllElements() as $element) {
- *         // doSomethingWith($element);
+ *     // start the operation, keep the operation name, and resume later
+ *     $operationResponse = $databaseAdminClient->createDatabase($formattedParent, $createStatement);
+ *     $operationName = $operationResponse->getName();
+ *     // ... do other work
+ *     $newOperationResponse = $databaseAdminClient->resumeOperation($operationName, 'createDatabase');
+ *     while (!$newOperationResponse->isDone()) {
+ *         // ... do other work
+ *         $newOperationResponse->reload();
+ *     }
+ *     if ($newOperationResponse->operationSucceeded()) {
+ *       $result = $newOperationResponse->getResult();
+ *       // doSomethingWith($result)
+ *     } else {
+ *       $error = $newOperationResponse->getError();
+ *       // handleError($error)
  *     }
  * } finally {
  *     $databaseAdminClient->close();
@@ -362,95 +376,14 @@ public function __construct(array $options = [])
         $this->operationsClient = $this->createOperationsClient($clientOptions);
     }
 
-    /**
-     * Lists Cloud Spanner databases.
-     *
-     * Sample code:
-     * ```
-     * $databaseAdminClient = new DatabaseAdminClient();
-     * try {
-     *     $formattedParent = $databaseAdminClient->instanceName('[PROJECT]', '[INSTANCE]');
-     *     // Iterate over pages of elements
-     *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
-     *     foreach ($pagedResponse->iteratePages() as $page) {
-     *         foreach ($page as $element) {
-     *             // doSomethingWith($element);
-     *         }
-     *     }
-     *
-     *
-     *     // Alternatively:
-     *
-     *     // Iterate through all elements
-     *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
-     *     foreach ($pagedResponse->iterateAllElements() as $element) {
-     *         // doSomethingWith($element);
-     *     }
-     * } finally {
-     *     $databaseAdminClient->close();
-     * }
-     * ```
-     *
-     * @param string $parent       Required. The instance whose databases should be listed.
-     *                             Values are of the form `projects/<project>/instances/<instance>`.
-     * @param array  $optionalArgs {
-     *                             Optional.
-     *
-     *     @type int $pageSize
-     *          The maximum number of resources contained in the underlying API
-     *          response. The API may return fewer values in a page, even if
-     *          there are additional values to be retrieved.
-     *     @type string $pageToken
-     *          A page token is used to specify a page of values to be returned.
-     *          If no page token is specified (the default), the first page
-     *          of values will be returned. Any page token used here must have
-     *          been generated by a previous call to the API.
-     *     @type RetrySettings|array $retrySettings
-     *          Retry settings to use for this call. Can be a
-     *          {@see Google\ApiCore\RetrySettings} object, or an associative array
-     *          of retry settings parameters. See the documentation on
-     *          {@see Google\ApiCore\RetrySettings} for example usage.
-     * }
-     *
-     * @return \Google\ApiCore\PagedListResponse
-     *
-     * @throws ApiException if the remote call fails
-     * @experimental
-     */
-    public function listDatabases($parent, array $optionalArgs = [])
-    {
-        $request = new ListDatabasesRequest();
-        $request->setParent($parent);
-        if (isset($optionalArgs['pageSize'])) {
-            $request->setPageSize($optionalArgs['pageSize']);
-        }
-        if (isset($optionalArgs['pageToken'])) {
-            $request->setPageToken($optionalArgs['pageToken']);
-        }
-
-        $requestParams = new RequestParamsHeaderDescriptor([
-          'parent' => $request->getParent(),
-        ]);
-        $optionalArgs['headers'] = isset($optionalArgs['headers'])
-            ? array_merge($requestParams->getHeader(), $optionalArgs['headers'])
-            : $requestParams->getHeader();
-
-        return $this->getPagedListResponse(
-            'ListDatabases',
-            $optionalArgs,
-            ListDatabasesResponse::class,
-            $request
-        );
-    }
-
     /**
      * Creates a new Cloud Spanner database and starts to prepare it for serving.
      * The returned [long-running operation][google.longrunning.Operation] will
      * have a name of the format `<database_name>/operations/<operation_id>` and
      * can be used to track preparation of the database. The
      * [metadata][google.longrunning.Operation.metadata] field type is
-     * [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
-     * [response][google.longrunning.Operation.response] field type is
+     * [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata].
+     * The [response][google.longrunning.Operation.response] field type is
      * [Database][google.spanner.admin.database.v1.Database], if successful.
      *
      * Sample code:
@@ -602,7 +535,8 @@ public function getDatabase($name, array $optionalArgs = [])
      * the format `<database_name>/operations/<operation_id>` and can be used to
      * track execution of the schema change(s). The
      * [metadata][google.longrunning.Operation.metadata] field type is
-     * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].  The operation has no response.
+     * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].
+     * The operation has no response.
      *
      * Sample code:
      * ```
@@ -655,18 +589,20 @@ public function getDatabase($name, array $optionalArgs = [])
      *
      *          Specifying an explicit operation ID simplifies determining
      *          whether the statements were executed in the event that the
-     *          [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] call is replayed,
-     *          or the return value is otherwise lost: the [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database] and
-     *          `operation_id` fields can be combined to form the
+     *          [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
+     *          call is replayed, or the return value is otherwise lost: the
+     *          [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database]
+     *          and `operation_id` fields can be combined to form the
      *          [name][google.longrunning.Operation.name] of the resulting
-     *          [longrunning.Operation][google.longrunning.Operation]: `<database>/operations/<operation_id>`.
+     *          [longrunning.Operation][google.longrunning.Operation]:
+     *          `<database>/operations/<operation_id>`.
      *
      *          `operation_id` should be unique within the database, and must be
      *          a valid identifier: `[a-z][a-z0-9_]*`. Note that
      *          automatically-generated operation IDs always begin with an
      *          underscore. If the named operation already exists,
-     *          [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] returns
-     *          `ALREADY_EXISTS`.
+     *          [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
+     *          returns `ALREADY_EXISTS`.
      *     @type RetrySettings|array $retrySettings
      *          Retry settings to use for this call. Can be a
      *          {@see Google\ApiCore\RetrySettings} object, or an associative array
@@ -814,9 +750,9 @@ public function getDatabaseDdl($database, array $optionalArgs = [])
      * ```
      * $databaseAdminClient = new DatabaseAdminClient();
      * try {
-     *     $formattedResource = $databaseAdminClient->databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
+     *     $resource = '';
      *     $policy = new Policy();
-     *     $response = $databaseAdminClient->setIamPolicy($formattedResource, $policy);
+     *     $response = $databaseAdminClient->setIamPolicy($resource, $policy);
      * } finally {
      *     $databaseAdminClient->close();
      * }
@@ -876,8 +812,8 @@ public function setIamPolicy($resource, $policy, array $optionalArgs = [])
      * ```
      * $databaseAdminClient = new DatabaseAdminClient();
      * try {
-     *     $formattedResource = $databaseAdminClient->databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
-     *     $response = $databaseAdminClient->getIamPolicy($formattedResource);
+     *     $resource = '';
+     *     $response = $databaseAdminClient->getIamPolicy($resource);
      * } finally {
      *     $databaseAdminClient->close();
      * }
@@ -938,9 +874,9 @@ public function getIamPolicy($resource, array $optionalArgs = [])
      * ```
      * $databaseAdminClient = new DatabaseAdminClient();
      * try {
-     *     $formattedResource = $databaseAdminClient->databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
+     *     $resource = '';
      *     $permissions = [];
-     *     $response = $databaseAdminClient->testIamPermissions($formattedResource, $permissions);
+     *     $response = $databaseAdminClient->testIamPermissions($resource, $permissions);
      * } finally {
      *     $databaseAdminClient->close();
      * }
@@ -987,4 +923,85 @@ public function testIamPermissions($resource, $permissions, array $optionalArgs
             $request
         )->wait();
     }
+
+    /**
+     * Lists Cloud Spanner databases.
+     *
+     * Sample code:
+     * ```
+     * $databaseAdminClient = new DatabaseAdminClient();
+     * try {
+     *     $formattedParent = $databaseAdminClient->instanceName('[PROJECT]', '[INSTANCE]');
+     *     // Iterate over pages of elements
+     *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
+     *     foreach ($pagedResponse->iteratePages() as $page) {
+     *         foreach ($page as $element) {
+     *             // doSomethingWith($element);
+     *         }
+     *     }
+     *
+     *
+     *     // Alternatively:
+     *
+     *     // Iterate through all elements
+     *     $pagedResponse = $databaseAdminClient->listDatabases($formattedParent);
+     *     foreach ($pagedResponse->iterateAllElements() as $element) {
+     *         // doSomethingWith($element);
+     *     }
+     * } finally {
+     *     $databaseAdminClient->close();
+     * }
+     * ```
+     *
+     * @param string $parent       Required. The instance whose databases should be listed.
+     *                             Values are of the form `projects/<project>/instances/<instance>`.
+     * @param array  $optionalArgs {
+     *                             Optional.
+     *
+     *     @type int $pageSize
+     *          The maximum number of resources contained in the underlying API
+     *          response. The API may return fewer values in a page, even if
+     *          there are additional values to be retrieved.
+     *     @type string $pageToken
+     *          A page token is used to specify a page of values to be returned.
+     *          If no page token is specified (the default), the first page
+     *          of values will be returned. Any page token used here must have
+     *          been generated by a previous call to the API.
+     *     @type RetrySettings|array $retrySettings
+     *          Retry settings to use for this call. Can be a
+     *          {@see Google\ApiCore\RetrySettings} object, or an associative array
+     *          of retry settings parameters. See the documentation on
+     *          {@see Google\ApiCore\RetrySettings} for example usage.
+     * }
+     *
+     * @return \Google\ApiCore\PagedListResponse
+     *
+     * @throws ApiException if the remote call fails
+     * @experimental
+     */
+    public function listDatabases($parent, array $optionalArgs = [])
+    {
+        $request = new ListDatabasesRequest();
+        $request->setParent($parent);
+        if (isset($optionalArgs['pageSize'])) {
+            $request->setPageSize($optionalArgs['pageSize']);
+        }
+        if (isset($optionalArgs['pageToken'])) {
+            $request->setPageToken($optionalArgs['pageToken']);
+        }
+
+        $requestParams = new RequestParamsHeaderDescriptor([
+          'parent' => $request->getParent(),
+        ]);
+        $optionalArgs['headers'] = isset($optionalArgs['headers'])
+            ? array_merge($requestParams->getHeader(), $optionalArgs['headers'])
+            : $requestParams->getHeader();
+
+        return $this->getPagedListResponse(
+            'ListDatabases',
+            $optionalArgs,
+            ListDatabasesResponse::class,
+            $request
+        );
+    }
 }
diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php b/Spanner/src/Admin/Database/V1/GetDatabaseDdlRequest.php
diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php b/Spanner/src/Admin/Database/V1/GetDatabaseDdlResponse.php
diff --git a/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php b/Spanner/src/Admin/Database/V1/GetDatabaseRequest.php