Commit ⋅ googleapis/nodejs-spanner

Showing 3 of 7 files from the diff.

99.52% 98.88% ø

src/v1/database_admin_client.ts changed.

99.28% 97.81% ø

src/v1/spanner_client.ts changed.

99.18% 98.10% ø

src/v1/instance_admin_client.ts changed.

Other files ignored by Codecov

package.json has changed.

test/codec.ts has changed.

synth.metadata has changed.

.kokoro/trampoline_v2.sh has changed.

@@ -67,8 +67,10 @@

  /**
   * Construct an instance of DatabaseAdminClient.
   *
   * @param {object} [options] - The configuration object. See the subsequent
   *   parameters for more details.
   * @param {object} [options] - The configuration object.
   * The options accepted by the constructor are described in detail
   * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
   * The common options are:
   * @param {object} [options.credentials] - Credentials object.
   * @param {string} [options.credentials.client_email]
   * @param {string} [options.credentials.private_key]

@@ -88,42 +90,33 @@

   *     your project ID will be detected automatically.
   * @param {string} [options.apiEndpoint] - The domain name of the
   *     API remote host.
   * @param {gax.ClientConfig} [options.clientConfig] - client configuration override.
   *     TODO(@alexander-fenster): link to gax documentation.
   * @param {boolean} fallback - Use HTTP fallback mode.
   *     In fallback mode, a special browser-compatible transport implementation is used
   *     instead of gRPC transport. In browser context (if the `window` object is defined)
   *     the fallback mode is enabled automatically; set `options.fallback` to `false`
   *     if you need to override this behavior.
   */

  constructor(opts?: ClientOptions) {
    // Ensure that options include the service address and port.
    // Ensure that options include all the required fields.
    const staticMembers = this.constructor as typeof DatabaseAdminClient;
    const servicePath =
      opts && opts.servicePath
        ? opts.servicePath
        : opts && opts.apiEndpoint
        ? opts.apiEndpoint
        : staticMembers.servicePath;
    const port = opts && opts.port ? opts.port : staticMembers.port;
      opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
    const port = opts?.port || staticMembers.port;
    const clientConfig = opts?.clientConfig ?? {};
    const fallback = opts?.fallback ?? typeof window !== 'undefined';
    opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);

    if (!opts) {
      opts = {servicePath, port};
    // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
    if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
      opts['scopes'] = staticMembers.scopes;
    }
    opts.servicePath = opts.servicePath || servicePath;
    opts.port = opts.port || port;

    // users can override the config from client side, like retry codes name.
    // The detailed structure of the clientConfig can be found here: https://github.com/googleapis/gax-nodejs/blob/master/src/gax.ts#L546
    // The way to override client config for Showcase API:
    //
    // const customConfig = {"interfaces": {"google.showcase.v1beta1.Echo": {"methods": {"Echo": {"retry_codes_name": "idempotent", "retry_params_name": "default"}}}}}
    // const showcaseClient = new showcaseClient({ projectId, customConfig });
    opts.clientConfig = opts.clientConfig || {};

    // If we're running in browser, it's OK to omit `fallback` since
    // google-gax has `browser` field in its `package.json`.
    // For Electron (which does not respect `browser` field),
    // pass `{fallback: true}` to the DatabaseAdminClient constructor.
    // Choose either gRPC or proto-over-HTTP implementation of google-gax.
    this._gaxModule = opts.fallback ? gax.fallback : gax;

    // Create a `gaxGrpc` object, with any grpc-specific options
    // sent to the client.
    opts.scopes = (this.constructor as typeof DatabaseAdminClient).scopes;
    // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
    this._gaxGrpc = new this._gaxModule.GrpcClient(opts);

    // Save options to use in initialize() method.

@@ -132,6 +125,11 @@

    // Save the auth object to the client, for use by other methods.
    this.auth = this._gaxGrpc.auth as gax.GoogleAuth;

    // Set the default scopes in auth client if needed.
    if (servicePath === staticMembers.servicePath) {
      this.auth.defaultScopes = staticMembers.scopes;
    }

    // Determine the client header string.
    const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
    if (typeof process !== 'undefined' && 'versions' in process) {

@@ -364,6 +362,7 @@


  /**
   * The DNS address for this API service.
   * @returns {string} The DNS address for this service.
   */
  static get servicePath() {
    return 'spanner.googleapis.com';

@@ -372,6 +371,7 @@

  /**
   * The DNS address for this API service - same as servicePath(),
   * exists for compatibility reasons.
   * @returns {string} The DNS address for this service.
   */
  static get apiEndpoint() {
    return 'spanner.googleapis.com';

@@ -379,6 +379,7 @@


  /**
   * The port for this API service.
   * @returns {number} The default port for this service.
   */
  static get port() {
    return 443;

@@ -387,6 +388,7 @@

  /**
   * The scopes needed to make gRPC calls for every method defined
   * in this service.
   * @returns {string[]} List of default scopes.
   */
  static get scopes() {
    return [

@@ -399,8 +401,7 @@

  getProjectId(callback: Callback<string, undefined, undefined>): void;
  /**
   * Return the project ID used by this class.
   * @param {function(Error, string)} callback - the callback to
   *   be called with the current project Id.
   * @returns {Promise} A promise that resolves to string containing the project ID.
   */
  getProjectId(
    callback?: Callback<string, undefined, undefined>

@@ -458,7 +459,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Database]{@link google.spanner.admin.database.v1.Database}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getDatabase(request);
   */
  getDatabase(
    request: protos.google.spanner.admin.database.v1.IGetDatabaseRequest,

@@ -548,7 +553,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.dropDatabase(request);
   */
  dropDatabase(
    request: protos.google.spanner.admin.database.v1.IDropDatabaseRequest,

@@ -641,7 +650,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [GetDatabaseDdlResponse]{@link google.spanner.admin.database.v1.GetDatabaseDdlResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getDatabaseDdl(request);
   */
  getDatabaseDdl(
    request: protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest,

@@ -740,7 +753,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.setIamPolicy(request);
   */
  setIamPolicy(
    request: protos.google.iam.v1.ISetIamPolicyRequest,

@@ -831,7 +848,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getIamPolicy(request);
   */
  getIamPolicy(
    request: protos.google.iam.v1.IGetIamPolicyRequest,

@@ -926,7 +947,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.testIamPermissions(request);
   */
  testIamPermissions(
    request: protos.google.iam.v1.ITestIamPermissionsRequest,

@@ -1012,7 +1037,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Backup]{@link google.spanner.admin.database.v1.Backup}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getBackup(request);
   */
  getBackup(
    request: protos.google.spanner.admin.database.v1.IGetBackupRequest,

@@ -1109,7 +1138,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Backup]{@link google.spanner.admin.database.v1.Backup}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.updateBackup(request);
   */
  updateBackup(
    request: protos.google.spanner.admin.database.v1.IUpdateBackupRequest,

@@ -1199,7 +1232,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.deleteBackup(request);
   */
  deleteBackup(
    request: protos.google.spanner.admin.database.v1.IDeleteBackupRequest,

@@ -1311,8 +1348,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.createDatabase(request);
   * const [response] = await operation.promise();
   */
  createDatabase(
    request: protos.google.spanner.admin.database.v1.ICreateDatabaseRequest,

@@ -1364,18 +1408,19 @@

    return this.innerApiCalls.createDatabase(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the createDatabase() method.
   * Check the status of the long running operation returned by `createDatabase()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkCreateDatabaseProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkCreateDatabaseProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkCreateDatabaseProgress(
    name: string

@@ -1473,8 +1518,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.updateDatabaseDdl(request);
   * const [response] = await operation.promise();
   */
  updateDatabaseDdl(
    request: protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest,

@@ -1526,18 +1578,19 @@

    return this.innerApiCalls.updateDatabaseDdl(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the updateDatabaseDdl() method.
   * Check the status of the long running operation returned by `updateDatabaseDdl()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkUpdateDatabaseDdlProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkUpdateDatabaseDdlProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkUpdateDatabaseDdlProgress(
    name: string

@@ -1629,8 +1682,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.createBackup(request);
   * const [response] = await operation.promise();
   */
  createBackup(
    request: protos.google.spanner.admin.database.v1.ICreateBackupRequest,

@@ -1682,18 +1742,19 @@

    return this.innerApiCalls.createBackup(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the createBackup() method.
   * Check the status of the long running operation returned by `createBackup()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkCreateBackupProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkCreateBackupProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkCreateBackupProgress(
    name: string

@@ -1791,8 +1852,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.restoreDatabase(request);
   * const [response] = await operation.promise();
   */
  restoreDatabase(
    request: protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest,

@@ -1844,18 +1912,19 @@

    return this.innerApiCalls.restoreDatabase(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the restoreDatabase() method.
   * Check the status of the long running operation returned by `restoreDatabase()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkRestoreDatabaseProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkRestoreDatabaseProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkRestoreDatabaseProgress(
    name: string

@@ -1929,19 +1998,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Database]{@link google.spanner.admin.database.v1.Database}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Database]{@link google.spanner.admin.database.v1.Database} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListDatabasesRequest]{@link google.spanner.admin.database.v1.ListDatabasesRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListDatabasesResponse]{@link google.spanner.admin.database.v1.ListDatabasesResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listDatabasesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listDatabases(
    request: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

@@ -1989,18 +2053,7 @@

  }

  /**
   * Equivalent to {@link listDatabases}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listDatabases} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2017,6 +2070,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Database]{@link google.spanner.admin.database.v1.Database} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listDatabasesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listDatabasesStream(
    request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

@@ -2041,10 +2101,9 @@

  }

  /**
   * Equivalent to {@link listDatabases}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listDatabases`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2060,7 +2119,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Database]{@link google.spanner.admin.database.v1.Database}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listDatabasesAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listDatabasesAsync(
    request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

@@ -2172,19 +2242,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Backup]{@link google.spanner.admin.database.v1.Backup}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Backup]{@link google.spanner.admin.database.v1.Backup} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListBackupsRequest]{@link google.spanner.admin.database.v1.ListBackupsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListBackupsResponse]{@link google.spanner.admin.database.v1.ListBackupsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listBackupsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listBackups(
    request: protos.google.spanner.admin.database.v1.IListBackupsRequest,

@@ -2232,18 +2297,7 @@

  }

  /**
   * Equivalent to {@link listBackups}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listBackups} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2296,6 +2350,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Backup]{@link google.spanner.admin.database.v1.Backup} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listBackupsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listBackupsStream(
    request?: protos.google.spanner.admin.database.v1.IListBackupsRequest,

@@ -2320,10 +2381,9 @@

  }

  /**
   * Equivalent to {@link listBackups}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listBackups`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2375,7 +2435,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Backup]{@link google.spanner.admin.database.v1.Backup}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listBackupsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listBackupsAsync(
    request?: protos.google.spanner.admin.database.v1.IListBackupsRequest,

@@ -2498,19 +2569,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Operation]{@link google.longrunning.Operation}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Operation]{@link google.longrunning.Operation} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListDatabaseOperationsRequest]{@link google.spanner.admin.database.v1.ListDatabaseOperationsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListDatabaseOperationsResponse]{@link google.spanner.admin.database.v1.ListDatabaseOperationsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listDatabaseOperationsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listDatabaseOperations(
    request: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

@@ -2562,18 +2628,7 @@

  }

  /**
   * Equivalent to {@link listDatabaseOperations}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listDatabaseOperations} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2632,6 +2687,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Operation]{@link google.longrunning.Operation} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listDatabaseOperationsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listDatabaseOperationsStream(
    request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

@@ -2656,10 +2718,9 @@

  }

  /**
   * Equivalent to {@link listDatabaseOperations}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listDatabaseOperations`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2717,7 +2778,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Operation]{@link google.longrunning.Operation}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listDatabaseOperationsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listDatabaseOperationsAsync(
    request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

@@ -2840,19 +2912,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Operation]{@link google.longrunning.Operation}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Operation]{@link google.longrunning.Operation} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListBackupOperationsRequest]{@link google.spanner.admin.database.v1.ListBackupOperationsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListBackupOperationsResponse]{@link google.spanner.admin.database.v1.ListBackupOperationsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listBackupOperationsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listBackupOperations(
    request: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest,

@@ -2900,18 +2967,7 @@

  }

  /**
   * Equivalent to {@link listBackupOperations}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listBackupOperations} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -2968,6 +3024,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Operation]{@link google.longrunning.Operation} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listBackupOperationsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listBackupOperationsStream(
    request?: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest,

@@ -2992,10 +3055,9 @@

  }

  /**
   * Equivalent to {@link listBackupOperations}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listBackupOperations`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -3051,7 +3113,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Operation]{@link google.longrunning.Operation}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listBackupOperationsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listBackupOperationsAsync(
    request?: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest,

@@ -3214,9 +3287,10 @@

  }

  /**
   * Terminate the GRPC channel and close the client.
   * Terminate the gRPC channel and close the client.
   *
   * The client will no longer be usable and all future behavior is undefined.
   * @returns {Promise} A promise that resolves when the client is closed.
   */
  close(): Promise<void> {
    this.initialize();

@@ -63,8 +63,10 @@

  /**
   * Construct an instance of SpannerClient.
   *
   * @param {object} [options] - The configuration object. See the subsequent
   *   parameters for more details.
   * @param {object} [options] - The configuration object.
   * The options accepted by the constructor are described in detail
   * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
   * The common options are:
   * @param {object} [options.credentials] - Credentials object.
   * @param {string} [options.credentials.client_email]
   * @param {string} [options.credentials.private_key]

@@ -84,42 +86,33 @@

   *     your project ID will be detected automatically.
   * @param {string} [options.apiEndpoint] - The domain name of the
   *     API remote host.
   * @param {gax.ClientConfig} [options.clientConfig] - client configuration override.
   *     TODO(@alexander-fenster): link to gax documentation.
   * @param {boolean} fallback - Use HTTP fallback mode.
   *     In fallback mode, a special browser-compatible transport implementation is used
   *     instead of gRPC transport. In browser context (if the `window` object is defined)
   *     the fallback mode is enabled automatically; set `options.fallback` to `false`
   *     if you need to override this behavior.
   */

  constructor(opts?: ClientOptions) {
    // Ensure that options include the service address and port.
    // Ensure that options include all the required fields.
    const staticMembers = this.constructor as typeof SpannerClient;
    const servicePath =
      opts && opts.servicePath
        ? opts.servicePath
        : opts && opts.apiEndpoint
        ? opts.apiEndpoint
        : staticMembers.servicePath;
    const port = opts && opts.port ? opts.port : staticMembers.port;
      opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
    const port = opts?.port || staticMembers.port;
    const clientConfig = opts?.clientConfig ?? {};
    const fallback = opts?.fallback ?? typeof window !== 'undefined';
    opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);

    if (!opts) {
      opts = {servicePath, port};
    // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
    if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
      opts['scopes'] = staticMembers.scopes;
    }
    opts.servicePath = opts.servicePath || servicePath;
    opts.port = opts.port || port;

    // users can override the config from client side, like retry codes name.
    // The detailed structure of the clientConfig can be found here: https://github.com/googleapis/gax-nodejs/blob/master/src/gax.ts#L546
    // The way to override client config for Showcase API:
    //
    // const customConfig = {"interfaces": {"google.showcase.v1beta1.Echo": {"methods": {"Echo": {"retry_codes_name": "idempotent", "retry_params_name": "default"}}}}}
    // const showcaseClient = new showcaseClient({ projectId, customConfig });
    opts.clientConfig = opts.clientConfig || {};

    // If we're running in browser, it's OK to omit `fallback` since
    // google-gax has `browser` field in its `package.json`.
    // For Electron (which does not respect `browser` field),
    // pass `{fallback: true}` to the SpannerClient constructor.
    // Choose either gRPC or proto-over-HTTP implementation of google-gax.
    this._gaxModule = opts.fallback ? gax.fallback : gax;

    // Create a `gaxGrpc` object, with any grpc-specific options
    // sent to the client.
    opts.scopes = (this.constructor as typeof SpannerClient).scopes;
    // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
    this._gaxGrpc = new this._gaxModule.GrpcClient(opts);

    // Save options to use in initialize() method.

@@ -128,6 +121,11 @@

    // Save the auth object to the client, for use by other methods.
    this.auth = this._gaxGrpc.auth as gax.GoogleAuth;

    // Set the default scopes in auth client if needed.
    if (servicePath === staticMembers.servicePath) {
      this.auth.defaultScopes = staticMembers.scopes;
    }

    // Determine the client header string.
    const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
    if (typeof process !== 'undefined' && 'versions' in process) {

@@ -287,6 +285,7 @@


  /**
   * The DNS address for this API service.
   * @returns {string} The DNS address for this service.
   */
  static get servicePath() {
    return 'spanner.googleapis.com';

@@ -295,6 +294,7 @@

  /**
   * The DNS address for this API service - same as servicePath(),
   * exists for compatibility reasons.
   * @returns {string} The DNS address for this service.
   */
  static get apiEndpoint() {
    return 'spanner.googleapis.com';

@@ -302,6 +302,7 @@


  /**
   * The port for this API service.
   * @returns {number} The default port for this service.
   */
  static get port() {
    return 443;

@@ -310,6 +311,7 @@

  /**
   * The scopes needed to make gRPC calls for every method defined
   * in this service.
   * @returns {string[]} List of default scopes.
   */
  static get scopes() {
    return [

@@ -322,8 +324,7 @@

  getProjectId(callback: Callback<string, undefined, undefined>): void;
  /**
   * Return the project ID used by this class.
   * @param {function(Error, string)} callback - the callback to
   *   be called with the current project Id.
   * @returns {Promise} A promise that resolves to string containing the project ID.
   */
  getProjectId(
    callback?: Callback<string, undefined, undefined>

@@ -396,7 +397,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Session]{@link google.spanner.v1.Session}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.createSession(request);
   */
  createSession(
    request: protos.google.spanner.v1.ICreateSessionRequest,

@@ -487,7 +492,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [BatchCreateSessionsResponse]{@link google.spanner.v1.BatchCreateSessionsResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.batchCreateSessions(request);
   */
  batchCreateSessions(
    request: protos.google.spanner.v1.IBatchCreateSessionsRequest,

@@ -571,7 +580,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Session]{@link google.spanner.v1.Session}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getSession(request);
   */
  getSession(
    request: protos.google.spanner.v1.IGetSessionRequest,

@@ -653,7 +666,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.deleteSession(request);
   */
  deleteSession(
    request: protos.google.spanner.v1.IDeleteSessionRequest,

@@ -807,7 +824,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [ResultSet]{@link google.spanner.v1.ResultSet}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.executeSql(request);
   */
  executeSql(
    request: protos.google.spanner.v1.IExecuteSqlRequest,

@@ -919,7 +940,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [ExecuteBatchDmlResponse]{@link google.spanner.v1.ExecuteBatchDmlResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.executeBatchDml(request);
   */
  executeBatchDml(
    request: protos.google.spanner.v1.IExecuteBatchDmlRequest,

@@ -1052,7 +1077,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [ResultSet]{@link google.spanner.v1.ResultSet}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.read(request);
   */
  read(
    request: protos.google.spanner.v1.IReadRequest,

@@ -1137,7 +1166,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Transaction]{@link google.spanner.v1.Transaction}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.beginTransaction(request);
   */
  beginTransaction(
    request: protos.google.spanner.v1.IBeginTransactionRequest,

@@ -1240,7 +1273,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [CommitResponse]{@link google.spanner.v1.CommitResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.commit(request);
   */
  commit(
    request: protos.google.spanner.v1.ICommitRequest,

@@ -1329,7 +1366,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.rollback(request);
   */
  rollback(
    request: protos.google.spanner.v1.IRollbackRequest,

@@ -1457,7 +1498,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [PartitionResponse]{@link google.spanner.v1.PartitionResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.partitionQuery(request);
   */
  partitionQuery(
    request: protos.google.spanner.v1.IPartitionQueryRequest,

@@ -1571,7 +1616,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [PartitionResponse]{@link google.spanner.v1.PartitionResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.partitionRead(request);
   */
  partitionRead(
    request: protos.google.spanner.v1.IPartitionReadRequest,

@@ -1693,6 +1742,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits [PartialResultSet]{@link google.spanner.v1.PartialResultSet} on 'data' event.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)
   *   for more details and examples.
   * @example
   * const stream = client.executeStreamingSql(request);
   * stream.on('data', (response) => { ... });
   * stream.on('end', () => { ... });
   */
  executeStreamingSql(
    request?: protos.google.spanner.v1.IExecuteSqlRequest,

@@ -1767,6 +1823,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits [PartialResultSet]{@link google.spanner.v1.PartialResultSet} on 'data' event.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)
   *   for more details and examples.
   * @example
   * const stream = client.streamingRead(request);
   * stream.on('data', (response) => { ... });
   * stream.on('end', () => { ... });
   */
  streamingRead(
    request?: protos.google.spanner.v1.IReadRequest,

@@ -1841,19 +1904,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Session]{@link google.spanner.v1.Session}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Session]{@link google.spanner.v1.Session} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListSessionsRequest]{@link google.spanner.v1.ListSessionsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListSessionsResponse]{@link google.spanner.v1.ListSessionsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listSessionsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listSessions(
    request: protos.google.spanner.v1.IListSessionsRequest,

@@ -1897,18 +1955,7 @@

  }

  /**
   * Equivalent to {@link listSessions}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listSessions} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.database

@@ -1935,6 +1982,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Session]{@link google.spanner.v1.Session} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listSessionsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listSessionsStream(
    request?: protos.google.spanner.v1.IListSessionsRequest,

@@ -1959,10 +2013,9 @@

  }

  /**
   * Equivalent to {@link listSessions}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listSessions`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.database

@@ -1988,7 +2041,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Session]{@link google.spanner.v1.Session}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listSessionsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listSessionsAsync(
    request?: protos.google.spanner.v1.IListSessionsRequest,

@@ -2133,9 +2197,10 @@

  }

  /**
   * Terminate the GRPC channel and close the client.
   * Terminate the gRPC channel and close the client.
   *
   * The client will no longer be usable and all future behavior is undefined.
   * @returns {Promise} A promise that resolves when the client is closed.
   */
  close(): Promise<void> {
    this.initialize();

@@ -82,8 +82,10 @@

  /**
   * Construct an instance of InstanceAdminClient.
   *
   * @param {object} [options] - The configuration object. See the subsequent
   *   parameters for more details.
   * @param {object} [options] - The configuration object.
   * The options accepted by the constructor are described in detail
   * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
   * The common options are:
   * @param {object} [options.credentials] - Credentials object.
   * @param {string} [options.credentials.client_email]
   * @param {string} [options.credentials.private_key]

@@ -103,42 +105,33 @@

   *     your project ID will be detected automatically.
   * @param {string} [options.apiEndpoint] - The domain name of the
   *     API remote host.
   * @param {gax.ClientConfig} [options.clientConfig] - client configuration override.
   *     TODO(@alexander-fenster): link to gax documentation.
   * @param {boolean} fallback - Use HTTP fallback mode.
   *     In fallback mode, a special browser-compatible transport implementation is used
   *     instead of gRPC transport. In browser context (if the `window` object is defined)
   *     the fallback mode is enabled automatically; set `options.fallback` to `false`
   *     if you need to override this behavior.
   */

  constructor(opts?: ClientOptions) {
    // Ensure that options include the service address and port.
    // Ensure that options include all the required fields.
    const staticMembers = this.constructor as typeof InstanceAdminClient;
    const servicePath =
      opts && opts.servicePath
        ? opts.servicePath
        : opts && opts.apiEndpoint
        ? opts.apiEndpoint
        : staticMembers.servicePath;
    const port = opts && opts.port ? opts.port : staticMembers.port;
      opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
    const port = opts?.port || staticMembers.port;
    const clientConfig = opts?.clientConfig ?? {};
    const fallback = opts?.fallback ?? typeof window !== 'undefined';
    opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);

    if (!opts) {
      opts = {servicePath, port};
    // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
    if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
      opts['scopes'] = staticMembers.scopes;
    }
    opts.servicePath = opts.servicePath || servicePath;
    opts.port = opts.port || port;

    // users can override the config from client side, like retry codes name.
    // The detailed structure of the clientConfig can be found here: https://github.com/googleapis/gax-nodejs/blob/master/src/gax.ts#L546
    // The way to override client config for Showcase API:
    //
    // const customConfig = {"interfaces": {"google.showcase.v1beta1.Echo": {"methods": {"Echo": {"retry_codes_name": "idempotent", "retry_params_name": "default"}}}}}
    // const showcaseClient = new showcaseClient({ projectId, customConfig });
    opts.clientConfig = opts.clientConfig || {};

    // If we're running in browser, it's OK to omit `fallback` since
    // google-gax has `browser` field in its `package.json`.
    // For Electron (which does not respect `browser` field),
    // pass `{fallback: true}` to the InstanceAdminClient constructor.
    // Choose either gRPC or proto-over-HTTP implementation of google-gax.
    this._gaxModule = opts.fallback ? gax.fallback : gax;

    // Create a `gaxGrpc` object, with any grpc-specific options
    // sent to the client.
    opts.scopes = (this.constructor as typeof InstanceAdminClient).scopes;
    // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
    this._gaxGrpc = new this._gaxModule.GrpcClient(opts);

    // Save options to use in initialize() method.

@@ -147,6 +140,11 @@

    // Save the auth object to the client, for use by other methods.
    this.auth = this._gaxGrpc.auth as gax.GoogleAuth;

    // Set the default scopes in auth client if needed.
    if (servicePath === staticMembers.servicePath) {
      this.auth.defaultScopes = staticMembers.scopes;
    }

    // Determine the client header string.
    const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
    if (typeof process !== 'undefined' && 'versions' in process) {

@@ -340,6 +338,7 @@


  /**
   * The DNS address for this API service.
   * @returns {string} The DNS address for this service.
   */
  static get servicePath() {
    return 'spanner.googleapis.com';

@@ -348,6 +347,7 @@

  /**
   * The DNS address for this API service - same as servicePath(),
   * exists for compatibility reasons.
   * @returns {string} The DNS address for this service.
   */
  static get apiEndpoint() {
    return 'spanner.googleapis.com';

@@ -355,6 +355,7 @@


  /**
   * The port for this API service.
   * @returns {number} The default port for this service.
   */
  static get port() {
    return 443;

@@ -363,6 +364,7 @@

  /**
   * The scopes needed to make gRPC calls for every method defined
   * in this service.
   * @returns {string[]} List of default scopes.
   */
  static get scopes() {
    return [

@@ -375,8 +377,7 @@

  getProjectId(callback: Callback<string, undefined, undefined>): void;
  /**
   * Return the project ID used by this class.
   * @param {function(Error, string)} callback - the callback to
   *   be called with the current project Id.
   * @returns {Promise} A promise that resolves to string containing the project ID.
   */
  getProjectId(
    callback?: Callback<string, undefined, undefined>

@@ -437,7 +438,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getInstanceConfig(request);
   */
  getInstanceConfig(
    request: protos.google.spanner.admin.instance.v1.IGetInstanceConfigRequest,

@@ -533,7 +538,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Instance]{@link google.spanner.admin.instance.v1.Instance}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getInstance(request);
   */
  getInstance(
    request: protos.google.spanner.admin.instance.v1.IGetInstanceRequest,

@@ -635,7 +644,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.deleteInstance(request);
   */
  deleteInstance(
    request: protos.google.spanner.admin.instance.v1.IDeleteInstanceRequest,

@@ -732,7 +745,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.setIamPolicy(request);
   */
  setIamPolicy(
    request: protos.google.iam.v1.ISetIamPolicyRequest,

@@ -820,7 +837,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getIamPolicy(request);
   */
  getIamPolicy(
    request: protos.google.iam.v1.IGetIamPolicyRequest,

@@ -911,7 +932,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.testIamPermissions(request);
   */
  testIamPermissions(
    request: protos.google.iam.v1.ITestIamPermissionsRequest,

@@ -1041,8 +1066,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.createInstance(request);
   * const [response] = await operation.promise();
   */
  createInstance(
    request: protos.google.spanner.admin.instance.v1.ICreateInstanceRequest,

@@ -1094,18 +1126,19 @@

    return this.innerApiCalls.createInstance(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the createInstance() method.
   * Check the status of the long running operation returned by `createInstance()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkCreateInstanceProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkCreateInstanceProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkCreateInstanceProgress(
    name: string

@@ -1220,8 +1253,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.updateInstance(request);
   * const [response] = await operation.promise();
   */
  updateInstance(
    request: protos.google.spanner.admin.instance.v1.IUpdateInstanceRequest,

@@ -1273,18 +1313,19 @@

    return this.innerApiCalls.updateInstance(request, options, callback);
  }
  /**
   * Check the status of the long running operation returned by the updateInstance() method.
   * Check the status of the long running operation returned by `updateInstance()`.
   * @param {String} name
   *   The operation name that will be passed.
   * @returns {Promise} - The promise which resolves to an object.
   *   The decoded operation object has result and metadata field to get information from.
   *
   * @example:
   *   const decodedOperation = await checkUpdateInstanceProgress(name);
   *   console.log(decodedOperation.result);
   *   console.log(decodedOperation.done);
   *   console.log(decodedOperation.metadata);
   *
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const decodedOperation = await checkUpdateInstanceProgress(name);
   * console.log(decodedOperation.result);
   * console.log(decodedOperation.done);
   * console.log(decodedOperation.metadata);
   */
  async checkUpdateInstanceProgress(
    name: string

@@ -1359,19 +1400,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListInstanceConfigsRequest]{@link google.spanner.admin.instance.v1.ListInstanceConfigsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListInstanceConfigsResponse]{@link google.spanner.admin.instance.v1.ListInstanceConfigsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listInstanceConfigsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstanceConfigs(
    request: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1419,18 +1455,7 @@

  }

  /**
   * Equivalent to {@link listInstanceConfigs}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listInstanceConfigs} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1448,6 +1473,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listInstanceConfigsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstanceConfigsStream(
    request?: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1472,10 +1504,9 @@

  }

  /**
   * Equivalent to {@link listInstanceConfigs}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listInstanceConfigs`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1492,7 +1523,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listInstanceConfigsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listInstanceConfigsAsync(
    request?: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1586,19 +1628,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Instance]{@link google.spanner.admin.instance.v1.Instance}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Instance]{@link google.spanner.admin.instance.v1.Instance} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListInstancesRequest]{@link google.spanner.admin.instance.v1.ListInstancesRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListInstancesResponse]{@link google.spanner.admin.instance.v1.ListInstancesResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listInstancesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstances(
    request: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1646,18 +1683,7 @@

  }

  /**
   * Equivalent to {@link listInstances}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listInstances} continuously
   * and invokes the callback registered for 'data' event for each element in the
   * responses.
   *
   * The returned object has 'end' method when no more elements are required.
   *
   * autoPaginate option will be ignored.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1694,6 +1720,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Instance]{@link google.spanner.admin.instance.v1.Instance} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listInstancesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstancesStream(
    request?: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1718,10 +1751,9 @@

  }

  /**
   * Equivalent to {@link listInstances}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listInstances`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1757,7 +1789,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Instance]{@link google.spanner.admin.instance.v1.Instance}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listInstancesAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listInstancesAsync(
    request?: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1885,9 +1928,10 @@

  }

  /**
   * Terminate the GRPC channel and close the client.
   * Terminate the gRPC channel and close the client.
   *
   * The client will no longer be usable and all future behavior is undefined.
   * @returns {Promise} A promise that resolves when the client is closed.
   */
  close(): Promise<void> {
    this.initialize();

Files		•	•	•	Coverage
bin	223	0	0	223	0.00%
src	21,391	21,334	9	48	99.73%
.mocharc.js	29	23	0	6	79.31%
.prettierrc.js	17	0	0	17	0.00%
Project Totals (23 files)	21,660	21,357	9	294	98.60%

Build #361858302 -

View CI Build Download

Build #361858302 -

View CI Build Download

Build #361858302 -

View CI Build Download

Build #361858302 -

View CI Build Download

Build #361858302 -

View CI Build Download

No yaml found.

Create your codecov.yml to customize your Codecov experience

Read the docs

Interact now

The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.

SVG

Learn more about the coverage sunburst graph

1109	1138		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1110	1139		* @returns {Promise} - The promise which resolves to an array.
1111	1140		* The first element of the array is an object representing [Backup]{@link google.spanner.admin.database.v1.Backup}.
1112		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1141	+	* Please see the
	1142	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
	1143	+	* for more details and examples.
	1144	+	* @example
	1145	+	* const [response] = await client.updateBackup(request);
1113	1146		*/
1114	1147		updateBackup(
1115	1148		request: protos.google.spanner.admin.database.v1.IUpdateBackupRequest,

1364	1408		return this.innerApiCalls.createDatabase(request, options, callback);
1365	1409		}
1366	1410		/**
1367		-	* Check the status of the long running operation returned by the createDatabase() method.
	1411	+	* Check the status of the long running operation returned by `createDatabase()`.
1368	1412		* @param {String} name
1369	1413		* The operation name that will be passed.
1370	1414		* @returns {Promise} - The promise which resolves to an object.
1371	1415		* The decoded operation object has result and metadata field to get information from.
1372		-	*
1373		-	* @example:
1374		-	* const decodedOperation = await checkCreateDatabaseProgress(name);
1375		-	* console.log(decodedOperation.result);
1376		-	* console.log(decodedOperation.done);
1377		-	* console.log(decodedOperation.metadata);
1378		-	*
	1416	+	* Please see the
	1417	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1418	+	* for more details and examples.
	1419	+	* @example
	1420	+	* const decodedOperation = await checkCreateDatabaseProgress(name);
	1421	+	* console.log(decodedOperation.result);
	1422	+	* console.log(decodedOperation.done);
	1423	+	* console.log(decodedOperation.metadata);
1379	1424		*/
1380	1425		async checkCreateDatabaseProgress(
1381	1426		name: string

1526	1578		return this.innerApiCalls.updateDatabaseDdl(request, options, callback);
1527	1579		}
1528	1580		/**
1529		-	* Check the status of the long running operation returned by the updateDatabaseDdl() method.
	1581	+	* Check the status of the long running operation returned by `updateDatabaseDdl()`.
1530	1582		* @param {String} name
1531	1583		* The operation name that will be passed.
1532	1584		* @returns {Promise} - The promise which resolves to an object.
1533	1585		* The decoded operation object has result and metadata field to get information from.
1534		-	*
1535		-	* @example:
1536		-	* const decodedOperation = await checkUpdateDatabaseDdlProgress(name);
1537		-	* console.log(decodedOperation.result);
1538		-	* console.log(decodedOperation.done);
1539		-	* console.log(decodedOperation.metadata);
1540		-	*
	1586	+	* Please see the
	1587	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1588	+	* for more details and examples.
	1589	+	* @example
	1590	+	* const decodedOperation = await checkUpdateDatabaseDdlProgress(name);
	1591	+	* console.log(decodedOperation.result);
	1592	+	* console.log(decodedOperation.done);
	1593	+	* console.log(decodedOperation.metadata);
1541	1594		*/
1542	1595		async checkUpdateDatabaseDdlProgress(
1543	1596		name: string

1844	1912		return this.innerApiCalls.restoreDatabase(request, options, callback);
1845	1913		}
1846	1914		/**
1847		-	* Check the status of the long running operation returned by the restoreDatabase() method.
	1915	+	* Check the status of the long running operation returned by `restoreDatabase()`.
1848	1916		* @param {String} name
1849	1917		* The operation name that will be passed.
1850	1918		* @returns {Promise} - The promise which resolves to an object.
1851	1919		* The decoded operation object has result and metadata field to get information from.
1852		-	*
1853		-	* @example:
1854		-	* const decodedOperation = await checkRestoreDatabaseProgress(name);
1855		-	* console.log(decodedOperation.result);
1856		-	* console.log(decodedOperation.done);
1857		-	* console.log(decodedOperation.metadata);
1858		-	*
	1920	+	* Please see the
	1921	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1922	+	* for more details and examples.
	1923	+	* @example
	1924	+	* const decodedOperation = await checkRestoreDatabaseProgress(name);
	1925	+	* console.log(decodedOperation.result);
	1926	+	* console.log(decodedOperation.done);
	1927	+	* console.log(decodedOperation.metadata);
1859	1928		*/
1860	1929		async checkRestoreDatabaseProgress(
1861	1930		name: string

1929	1998		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1930	1999		* @returns {Promise} - The promise which resolves to an array.
1931	2000		* The first element of the array is Array of [Database]{@link google.spanner.admin.database.v1.Database}.
1932		-	* The client library support auto-pagination by default: it will call the API as many
	2001	+	* The client library will perform auto-pagination by default: it will call the API as many
1933	2002		* times as needed and will merge results from all the pages into this array.
1934		-	*
1935		-	* When autoPaginate: false is specified through options, the array has three elements.
1936		-	* The first element is Array of [Database]{@link google.spanner.admin.database.v1.Database} that corresponds to
1937		-	* the one page received from the API server.
1938		-	* If the second element is not null it contains the request object of type [ListDatabasesRequest]{@link google.spanner.admin.database.v1.ListDatabasesRequest}
1939		-	* that can be used to obtain the next page of the results.
1940		-	* If it is null, the next page does not exist.
1941		-	* The third element contains the raw response received from the API server. Its type is
1942		-	* [ListDatabasesResponse]{@link google.spanner.admin.database.v1.ListDatabasesResponse}.
1943		-	*
1944		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	2003	+	* Note that it can affect your quota.
	2004	+	* We recommend using `listDatabasesAsync()`
	2005	+	* method described below for async iteration which you can stop as needed.
	2006	+	* Please see the
	2007	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2008	+	* for more details and examples.
1945	2009		*/
1946	2010		listDatabases(
1947	2011		request: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

67	67		/**
68	68		* Construct an instance of DatabaseAdminClient.
69	69		*
70		-	* @param {object} [options] - The configuration object. See the subsequent
71		-	* parameters for more details.
	70	+	* @param {object} [options] - The configuration object.
	71	+	* The options accepted by the constructor are described in detail
	72	+	* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
	73	+	* The common options are:
72	74		* @param {object} [options.credentials] - Credentials object.
73	75		* @param {string} [options.credentials.client_email]
74	76		* @param {string} [options.credentials.private_key]

88	90		* your project ID will be detected automatically.
89	91		* @param {string} [options.apiEndpoint] - The domain name of the
90	92		* API remote host.
	93	+	* @param {gax.ClientConfig} [options.clientConfig] - client configuration override.
	94	+	* TODO(@alexander-fenster): link to gax documentation.
	95	+	* @param {boolean} fallback - Use HTTP fallback mode.
	96	+	* In fallback mode, a special browser-compatible transport implementation is used
	97	+	* instead of gRPC transport. In browser context (if the `window` object is defined)
	98	+	* the fallback mode is enabled automatically; set `options.fallback` to `false`
	99	+	* if you need to override this behavior.
91	100		*/
92		-
93	101		constructor(opts?: ClientOptions) {
94		-	// Ensure that options include the service address and port.
	102	+	// Ensure that options include all the required fields.
95	103		const staticMembers = this.constructor as typeof DatabaseAdminClient;
96	104		const servicePath =
97		-	opts && opts.servicePath
98		-	? opts.servicePath
99		-	: opts && opts.apiEndpoint
100		-	? opts.apiEndpoint
101		-	: staticMembers.servicePath;
102		-	const port = opts && opts.port ? opts.port : staticMembers.port;
	105	+	opts?.servicePath \|\| opts?.apiEndpoint \|\| staticMembers.servicePath;
	106	+	const port = opts?.port \|\| staticMembers.port;
	107	+	const clientConfig = opts?.clientConfig ?? {};
	108	+	const fallback = opts?.fallback ?? typeof window !== 'undefined';
	109	+	opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);
103	110
104		-	if (!opts) {
105		-	opts = {servicePath, port};
	111	+	// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
	112	+	if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
	113	+	opts['scopes'] = staticMembers.scopes;
106	114		}
107		-	opts.servicePath = opts.servicePath \|\| servicePath;
108		-	opts.port = opts.port \|\| port;
109		-
110		-	// users can override the config from client side, like retry codes name.
111		-	// The detailed structure of the clientConfig can be found here: https://github.com/googleapis/gax-nodejs/blob/master/src/gax.ts#L546
112		-	// The way to override client config for Showcase API:
113		-	//
114		-	// const customConfig = {"interfaces": {"google.showcase.v1beta1.Echo": {"methods": {"Echo": {"retry_codes_name": "idempotent", "retry_params_name": "default"}}}}}
115		-	// const showcaseClient = new showcaseClient({ projectId, customConfig });
116		-	opts.clientConfig = opts.clientConfig \|\| {};
117	115
118		-	// If we're running in browser, it's OK to omit `fallback` since
119		-	// google-gax has `browser` field in its `package.json`.
120		-	// For Electron (which does not respect `browser` field),
121		-	// pass `{fallback: true}` to the DatabaseAdminClient constructor.
	116	+	// Choose either gRPC or proto-over-HTTP implementation of google-gax.
122	117		this._gaxModule = opts.fallback ? gax.fallback : gax;
123	118
124		-	// Create a `gaxGrpc` object, with any grpc-specific options
125		-	// sent to the client.
126		-	opts.scopes = (this.constructor as typeof DatabaseAdminClient).scopes;
	119	+	// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
127	120		this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
128	121
129	122		// Save options to use in initialize() method.

132	125		// Save the auth object to the client, for use by other methods.
133	126		this.auth = this._gaxGrpc.auth as gax.GoogleAuth;
134	127
	128	+	// Set the default scopes in auth client if needed.
	129	+	if (servicePath === staticMembers.servicePath) {
	130	+	this.auth.defaultScopes = staticMembers.scopes;
	131	+	}
	132	+
135	133		// Determine the client header string.
136	134		const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
137	135		if (typeof process !== 'undefined' && 'versions' in process) {

364	362
365	363		/**
366	364		* The DNS address for this API service.
	365	+	* @returns {string} The DNS address for this service.
367	366		*/
368	367		static get servicePath() {
369	368		return 'spanner.googleapis.com';

372	371		/**
373	372		* The DNS address for this API service - same as servicePath(),
374	373		* exists for compatibility reasons.
	374	+	* @returns {string} The DNS address for this service.
375	375		*/
376	376		static get apiEndpoint() {
377	377		return 'spanner.googleapis.com';

379	379
380	380		/**
381	381		* The port for this API service.
	382	+	* @returns {number} The default port for this service.
382	383		*/
383	384		static get port() {
384	385		return 443;

387	388		/**
388	389		* The scopes needed to make gRPC calls for every method defined
389	390		* in this service.
	391	+	* @returns {string[]} List of default scopes.
390	392		*/
391	393		static get scopes() {
392	394		return [

399	401		getProjectId(callback: Callback<string, undefined, undefined>): void;
400	402		/**
401	403		* Return the project ID used by this class.
402		-	* @param {function(Error, string)} callback - the callback to
403		-	* be called with the current project Id.
	404	+	* @returns {Promise} A promise that resolves to string containing the project ID.
404	405		*/
405	406		getProjectId(
406	407		callback?: Callback<string, undefined, undefined>

1012	1037		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1013	1038		* @returns {Promise} - The promise which resolves to an array.
1014	1039		* The first element of the array is an object representing [Backup]{@link google.spanner.admin.database.v1.Backup}.
1015		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1040	+	* Please see the
	1041	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
	1042	+	* for more details and examples.
	1043	+	* @example
	1044	+	* const [response] = await client.getBackup(request);
1016	1045		*/
1017	1046		getBackup(
1018	1047		request: protos.google.spanner.admin.database.v1.IGetBackupRequest,

1199	1232		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1200	1233		* @returns {Promise} - The promise which resolves to an array.
1201	1234		* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
1202		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1235	+	* Please see the
	1236	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
	1237	+	* for more details and examples.
	1238	+	* @example
	1239	+	* const [response] = await client.deleteBackup(request);
1203	1240		*/
1204	1241		deleteBackup(
1205	1242		request: protos.google.spanner.admin.database.v1.IDeleteBackupRequest,

1311	1348		* @param {object} [options]
1312	1349		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1313	1350		* @returns {Promise} - The promise which resolves to an array.
1314		-	* The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
1315		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1351	+	* The first element of the array is an object representing
	1352	+	* a long running operation. Its `promise()` method returns a promise
	1353	+	* you can `await` for.
	1354	+	* Please see the
	1355	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1356	+	* for more details and examples.
	1357	+	* @example
	1358	+	* const [operation] = await client.createDatabase(request);
	1359	+	* const [response] = await operation.promise();
1316	1360		*/
1317	1361		createDatabase(
1318	1362		request: protos.google.spanner.admin.database.v1.ICreateDatabaseRequest,

1473	1518		* @param {object} [options]
1474	1519		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1475	1520		* @returns {Promise} - The promise which resolves to an array.
1476		-	* The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
1477		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1521	+	* The first element of the array is an object representing
	1522	+	* a long running operation. Its `promise()` method returns a promise
	1523	+	* you can `await` for.
	1524	+	* Please see the
	1525	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1526	+	* for more details and examples.
	1527	+	* @example
	1528	+	* const [operation] = await client.updateDatabaseDdl(request);
	1529	+	* const [response] = await operation.promise();
1478	1530		*/
1479	1531		updateDatabaseDdl(
1480	1532		request: protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest,

1629	1682		* @param {object} [options]
1630	1683		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1631	1684		* @returns {Promise} - The promise which resolves to an array.
1632		-	* The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
1633		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1685	+	* The first element of the array is an object representing
	1686	+	* a long running operation. Its `promise()` method returns a promise
	1687	+	* you can `await` for.
	1688	+	* Please see the
	1689	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1690	+	* for more details and examples.
	1691	+	* @example
	1692	+	* const [operation] = await client.createBackup(request);
	1693	+	* const [response] = await operation.promise();
1634	1694		*/
1635	1695		createBackup(
1636	1696		request: protos.google.spanner.admin.database.v1.ICreateBackupRequest,

1682	1742		return this.innerApiCalls.createBackup(request, options, callback);
1683	1743		}
1684	1744		/**
1685		-	* Check the status of the long running operation returned by the createBackup() method.
	1745	+	* Check the status of the long running operation returned by `createBackup()`.
1686	1746		* @param {String} name
1687	1747		* The operation name that will be passed.
1688	1748		* @returns {Promise} - The promise which resolves to an object.
1689	1749		* The decoded operation object has result and metadata field to get information from.
1690		-	*
1691		-	* @example:
1692		-	* const decodedOperation = await checkCreateBackupProgress(name);
1693		-	* console.log(decodedOperation.result);
1694		-	* console.log(decodedOperation.done);
1695		-	* console.log(decodedOperation.metadata);
1696		-	*
	1750	+	* Please see the
	1751	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1752	+	* for more details and examples.
	1753	+	* @example
	1754	+	* const decodedOperation = await checkCreateBackupProgress(name);
	1755	+	* console.log(decodedOperation.result);
	1756	+	* console.log(decodedOperation.done);
	1757	+	* console.log(decodedOperation.metadata);
1697	1758		*/
1698	1759		async checkCreateBackupProgress(
1699	1760		name: string

1791	1852		* @param {object} [options]
1792	1853		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
1793	1854		* @returns {Promise} - The promise which resolves to an array.
1794		-	* The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
1795		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	1855	+	* The first element of the array is an object representing
	1856	+	* a long running operation. Its `promise()` method returns a promise
	1857	+	* you can `await` for.
	1858	+	* Please see the
	1859	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1860	+	* for more details and examples.
	1861	+	* @example
	1862	+	* const [operation] = await client.restoreDatabase(request);
	1863	+	* const [response] = await operation.promise();
1796	1864		*/
1797	1865		restoreDatabase(
1798	1866		request: protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest,

1989	2053		}
1990	2054
1991	2055		/**
1992		-	* Equivalent to {@link listDatabases}, but returns a NodeJS Stream object.
1993		-	*
1994		-	* This fetches the paged responses for {@link listDatabases} continuously
1995		-	* and invokes the callback registered for 'data' event for each element in the
1996		-	* responses.
1997		-	*
1998		-	* The returned object has 'end' method when no more elements are required.
1999		-	*
2000		-	* autoPaginate option will be ignored.
2001		-	*
2002		-	* @see {@link https://nodejs.org/api/stream.html}
2003		-	*
	2056	+	* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
2004	2057		* @param {Object} request
2005	2058		* The request object that will be sent.
2006	2059		* @param {string} request.parent

2017	2070		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2018	2071		* @returns {Stream}
2019	2072		* An object stream which emits an object representing [Database]{@link google.spanner.admin.database.v1.Database} on 'data' event.
	2073	+	* The client library will perform auto-pagination by default: it will call the API as many
	2074	+	* times as needed. Note that it can affect your quota.
	2075	+	* We recommend using `listDatabasesAsync()`
	2076	+	* method described below for async iteration which you can stop as needed.
	2077	+	* Please see the
	2078	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2079	+	* for more details and examples.
2020	2080		*/
2021	2081		listDatabasesStream(
2022	2082		request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

2041	2101		}
2042	2102
2043	2103		/**
2044		-	* Equivalent to {@link listDatabases}, but returns an iterable object.
2045		-	*
2046		-	* for-await-of syntax is used with the iterable to recursively get response element on-demand.
	2104	+	* Equivalent to `listDatabases`, but returns an iterable object.
2047	2105		*
	2106	+	* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2048	2107		* @param {Object} request
2049	2108		* The request object that will be sent.
2050	2109		* @param {string} request.parent

2060	2119		* @param {object} [options]
2061	2120		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2062	2121		* @returns {Object}
2063		-	* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
	2122	+	* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
	2123	+	* When you iterate the returned iterable, each element will be an object representing
	2124	+	* [Database]{@link google.spanner.admin.database.v1.Database}. The API will be called under the hood as needed, once per the page,
	2125	+	* so you can stop the iteration when you don't need more results.
	2126	+	* Please see the
	2127	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2128	+	* for more details and examples.
	2129	+	* @example
	2130	+	* const iterable = client.listDatabasesAsync(request);
	2131	+	* for await (const response of iterable) {
	2132	+	* // process response
	2133	+	* }
2064	2134		*/
2065	2135		listDatabasesAsync(
2066	2136		request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest,

2172	2242		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2173	2243		* @returns {Promise} - The promise which resolves to an array.
2174	2244		* The first element of the array is Array of [Backup]{@link google.spanner.admin.database.v1.Backup}.
2175		-	* The client library support auto-pagination by default: it will call the API as many
	2245	+	* The client library will perform auto-pagination by default: it will call the API as many
2176	2246		* times as needed and will merge results from all the pages into this array.
2177		-	*
2178		-	* When autoPaginate: false is specified through options, the array has three elements.
2179		-	* The first element is Array of [Backup]{@link google.spanner.admin.database.v1.Backup} that corresponds to
2180		-	* the one page received from the API server.
2181		-	* If the second element is not null it contains the request object of type [ListBackupsRequest]{@link google.spanner.admin.database.v1.ListBackupsRequest}
2182		-	* that can be used to obtain the next page of the results.
2183		-	* If it is null, the next page does not exist.
2184		-	* The third element contains the raw response received from the API server. Its type is
2185		-	* [ListBackupsResponse]{@link google.spanner.admin.database.v1.ListBackupsResponse}.
2186		-	*
2187		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	2247	+	* Note that it can affect your quota.
	2248	+	* We recommend using `listBackupsAsync()`
	2249	+	* method described below for async iteration which you can stop as needed.
	2250	+	* Please see the
	2251	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2252	+	* for more details and examples.
2188	2253		*/
2189	2254		listBackups(
2190	2255		request: protos.google.spanner.admin.database.v1.IListBackupsRequest,

2232	2297		}
2233	2298
2234	2299		/**
2235		-	* Equivalent to {@link listBackups}, but returns a NodeJS Stream object.
2236		-	*
2237		-	* This fetches the paged responses for {@link listBackups} continuously
2238		-	* and invokes the callback registered for 'data' event for each element in the
2239		-	* responses.
2240		-	*
2241		-	* The returned object has 'end' method when no more elements are required.
2242		-	*
2243		-	* autoPaginate option will be ignored.
2244		-	*
2245		-	* @see {@link https://nodejs.org/api/stream.html}
2246		-	*
	2300	+	* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
2247	2301		* @param {Object} request
2248	2302		* The request object that will be sent.
2249	2303		* @param {string} request.parent

2296	2350		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2297	2351		* @returns {Stream}
2298	2352		* An object stream which emits an object representing [Backup]{@link google.spanner.admin.database.v1.Backup} on 'data' event.
	2353	+	* The client library will perform auto-pagination by default: it will call the API as many
	2354	+	* times as needed. Note that it can affect your quota.
	2355	+	* We recommend using `listBackupsAsync()`
	2356	+	* method described below for async iteration which you can stop as needed.
	2357	+	* Please see the
	2358	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2359	+	* for more details and examples.
2299	2360		*/
2300	2361		listBackupsStream(
2301	2362		request?: protos.google.spanner.admin.database.v1.IListBackupsRequest,

2320	2381		}
2321	2382
2322	2383		/**
2323		-	* Equivalent to {@link listBackups}, but returns an iterable object.
2324		-	*
2325		-	* for-await-of syntax is used with the iterable to recursively get response element on-demand.
	2384	+	* Equivalent to `listBackups`, but returns an iterable object.
2326	2385		*
	2386	+	* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2327	2387		* @param {Object} request
2328	2388		* The request object that will be sent.
2329	2389		* @param {string} request.parent

2375	2435		* @param {object} [options]
2376	2436		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2377	2437		* @returns {Object}
2378		-	* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
	2438	+	* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
	2439	+	* When you iterate the returned iterable, each element will be an object representing
	2440	+	* [Backup]{@link google.spanner.admin.database.v1.Backup}. The API will be called under the hood as needed, once per the page,
	2441	+	* so you can stop the iteration when you don't need more results.
	2442	+	* Please see the
	2443	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2444	+	* for more details and examples.
	2445	+	* @example
	2446	+	* const iterable = client.listBackupsAsync(request);
	2447	+	* for await (const response of iterable) {
	2448	+	* // process response
	2449	+	* }
2379	2450		*/
2380	2451		listBackupsAsync(
2381	2452		request?: protos.google.spanner.admin.database.v1.IListBackupsRequest,

2498	2569		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2499	2570		* @returns {Promise} - The promise which resolves to an array.
2500	2571		* The first element of the array is Array of [Operation]{@link google.longrunning.Operation}.
2501		-	* The client library support auto-pagination by default: it will call the API as many
	2572	+	* The client library will perform auto-pagination by default: it will call the API as many
2502	2573		* times as needed and will merge results from all the pages into this array.
2503		-	*
2504		-	* When autoPaginate: false is specified through options, the array has three elements.
2505		-	* The first element is Array of [Operation]{@link google.longrunning.Operation} that corresponds to
2506		-	* the one page received from the API server.
2507		-	* If the second element is not null it contains the request object of type [ListDatabaseOperationsRequest]{@link google.spanner.admin.database.v1.ListDatabaseOperationsRequest}
2508		-	* that can be used to obtain the next page of the results.
2509		-	* If it is null, the next page does not exist.
2510		-	* The third element contains the raw response received from the API server. Its type is
2511		-	* [ListDatabaseOperationsResponse]{@link google.spanner.admin.database.v1.ListDatabaseOperationsResponse}.
2512		-	*
2513		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	2574	+	* Note that it can affect your quota.
	2575	+	* We recommend using `listDatabaseOperationsAsync()`
	2576	+	* method described below for async iteration which you can stop as needed.
	2577	+	* Please see the
	2578	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2579	+	* for more details and examples.
2514	2580		*/
2515	2581		listDatabaseOperations(
2516	2582		request: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

2562	2628		}
2563	2629
2564	2630		/**
2565		-	* Equivalent to {@link listDatabaseOperations}, but returns a NodeJS Stream object.
2566		-	*
2567		-	* This fetches the paged responses for {@link listDatabaseOperations} continuously
2568		-	* and invokes the callback registered for 'data' event for each element in the
2569		-	* responses.
2570		-	*
2571		-	* The returned object has 'end' method when no more elements are required.
2572		-	*
2573		-	* autoPaginate option will be ignored.
2574		-	*
2575		-	* @see {@link https://nodejs.org/api/stream.html}
2576		-	*
	2631	+	* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
2577	2632		* @param {Object} request
2578	2633		* The request object that will be sent.
2579	2634		* @param {string} request.parent

2632	2687		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2633	2688		* @returns {Stream}
2634	2689		* An object stream which emits an object representing [Operation]{@link google.longrunning.Operation} on 'data' event.
	2690	+	* The client library will perform auto-pagination by default: it will call the API as many
	2691	+	* times as needed. Note that it can affect your quota.
	2692	+	* We recommend using `listDatabaseOperationsAsync()`
	2693	+	* method described below for async iteration which you can stop as needed.
	2694	+	* Please see the
	2695	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2696	+	* for more details and examples.
2635	2697		*/
2636	2698		listDatabaseOperationsStream(
2637	2699		request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

2656	2718		}
2657	2719
2658	2720		/**
2659		-	* Equivalent to {@link listDatabaseOperations}, but returns an iterable object.
2660		-	*
2661		-	* for-await-of syntax is used with the iterable to recursively get response element on-demand.
	2721	+	* Equivalent to `listDatabaseOperations`, but returns an iterable object.
2662	2722		*
	2723	+	* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2663	2724		* @param {Object} request
2664	2725		* The request object that will be sent.
2665	2726		* @param {string} request.parent

2717	2778		* @param {object} [options]
2718	2779		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2719	2780		* @returns {Object}
2720		-	* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
	2781	+	* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
	2782	+	* When you iterate the returned iterable, each element will be an object representing
	2783	+	* [Operation]{@link google.longrunning.Operation}. The API will be called under the hood as needed, once per the page,
	2784	+	* so you can stop the iteration when you don't need more results.
	2785	+	* Please see the
	2786	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2787	+	* for more details and examples.
	2788	+	* @example
	2789	+	* const iterable = client.listDatabaseOperationsAsync(request);
	2790	+	* for await (const response of iterable) {
	2791	+	* // process response
	2792	+	* }
2721	2793		*/
2722	2794		listDatabaseOperationsAsync(
2723	2795		request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest,

2840	2912		* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html\|CallOptions} for more details.
2841	2913		* @returns {Promise} - The promise which resolves to an array.
2842	2914		* The first element of the array is Array of [Operation]{@link google.longrunning.Operation}.
2843		-	* The client library support auto-pagination by default: it will call the API as many
	2915	+	* The client library will perform auto-pagination by default: it will call the API as many
2844	2916		* times as needed and will merge results from all the pages into this array.
2845		-	*
2846		-	* When autoPaginate: false is specified through options, the array has three elements.
2847		-	* The first element is Array of [Operation]{@link google.longrunning.Operation} that corresponds to
2848		-	* the one page received from the API server.
2849		-	* If the second element is not null it contains the request object of type [ListBackupOperationsRequest]{@link google.spanner.admin.database.v1.ListBackupOperationsRequest}
2850		-	* that can be used to obtain the next page of the results.
2851		-	* If it is null, the next page does not exist.
2852		-	* The third element contains the raw response received from the API server. Its type is
2853		-	* [ListBackupOperationsResponse]{@link google.spanner.admin.database.v1.ListBackupOperationsResponse}.
2854		-	*
2855		-	* The promise has a method named "cancel" which cancels the ongoing API call.
	2917	+	* Note that it can affect your quota.
	2918	+	* We recommend using `listBackupOperationsAsync()`
	2919	+	* method described below for async iteration which you can stop as needed.
	2920	+	* Please see the
	2921	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
	2922	+	* for more details and examples.
2856	2923		*/
2857	2924		listBackupOperations(
2858	2925		request: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest,