@google-cloud/spanner-api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +111 -0
  2. package/build/protos/google/spanner/admin/database/v1/backup.proto +773 -0
  3. package/build/protos/google/spanner/admin/database/v1/backup_schedule.proto +230 -0
  4. package/build/protos/google/spanner/admin/database/v1/common.proto +132 -0
  5. package/build/protos/google/spanner/admin/database/v1/spanner_database_admin.proto +1314 -0
  6. package/build/protos/google/spanner/admin/instance/v1/common.proto +64 -0
  7. package/build/protos/google/spanner/admin/instance/v1/spanner_instance_admin.proto +2184 -0
  8. package/build/protos/google/spanner/executor/v1/cloud_executor.proto +1610 -0
  9. package/build/protos/google/spanner/v1/change_stream.proto +451 -0
  10. package/build/protos/google/spanner/v1/commit_response.proto +80 -0
  11. package/build/protos/google/spanner/v1/keys.proto +163 -0
  12. package/build/protos/google/spanner/v1/location.proto +388 -0
  13. package/build/protos/google/spanner/v1/mutation.proto +156 -0
  14. package/build/protos/google/spanner/v1/query_plan.proto +156 -0
  15. package/build/protos/google/spanner/v1/result_set.proto +260 -0
  16. package/build/protos/google/spanner/v1/spanner.proto +1472 -0
  17. package/build/protos/google/spanner/v1/transaction.proto +329 -0
  18. package/build/protos/google/spanner/v1/type.proto +214 -0
  19. package/build/protos/protos.d.ts +42547 -0
  20. package/build/protos/protos.js +1 -0
  21. package/build/protos/protos.json +1 -0
  22. package/build/src/index.d.ts +20 -0
  23. package/build/src/index.js +34 -0
  24. package/build/src/index.js.map +1 -0
  25. package/build/src/v1/database_admin_client.d.ts +2433 -0
  26. package/build/src/v1/database_admin_client.js +2938 -0
  27. package/build/src/v1/database_admin_client.js.map +1 -0
  28. package/build/src/v1/database_admin_client_config.json +169 -0
  29. package/build/src/v1/database_admin_proto_list.json +6 -0
  30. package/build/src/v1/gapic_metadata.json +253 -0
  31. package/build/src/v1/index.d.ts +4 -0
  32. package/build/src/v1/index.js +29 -0
  33. package/build/src/v1/index.js.map +1 -0
  34. package/build/src/v1/instance_admin_client.d.ts +2162 -0
  35. package/build/src/v1/instance_admin_client.js +2411 -0
  36. package/build/src/v1/instance_admin_client.js.map +1 -0
  37. package/build/src/v1/instance_admin_client_config.json +129 -0
  38. package/build/src/v1/instance_admin_proto_list.json +4 -0
  39. package/build/src/v1/spanner_client.d.ts +1353 -0
  40. package/build/src/v1/spanner_client.js +1456 -0
  41. package/build/src/v1/spanner_client.js.map +1 -0
  42. package/build/src/v1/spanner_client_config.json +123 -0
  43. package/build/src/v1/spanner_executor_proxy_client.d.ts +419 -0
  44. package/build/src/v1/spanner_executor_proxy_client.js +730 -0
  45. package/build/src/v1/spanner_executor_proxy_client.js.map +1 -0
  46. package/build/src/v1/spanner_executor_proxy_client_config.json +30 -0
  47. package/build/src/v1/spanner_executor_proxy_proto_list.json +15 -0
  48. package/build/src/v1/spanner_proto_list.json +12 -0
  49. package/package.json +65 -0
@@ -0,0 +1,2433 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
3
+ import { Transform } from 'stream';
4
+ import * as protos from '../../protos/protos';
5
+ /**
6
+ * Cloud Spanner Database Admin API
7
+ *
8
+ * The Cloud Spanner Database Admin API can be used to:
9
+ * * create, drop, and list databases
10
+ * * update the schema of pre-existing databases
11
+ * * create, delete, copy and list backups for a database
12
+ * * restore a database from an existing backup
13
+ * @class
14
+ * @memberof v1
15
+ */
16
+ export declare class DatabaseAdminClient {
17
+ private _terminated;
18
+ private _opts;
19
+ private _providedCustomServicePath;
20
+ private _gaxModule;
21
+ private _gaxGrpc;
22
+ private _protos;
23
+ private _defaults;
24
+ private _universeDomain;
25
+ private _servicePath;
26
+ private _log;
27
+ auth: gax.GoogleAuth;
28
+ descriptors: Descriptors;
29
+ warn: (code: string, message: string, warnType?: string) => void;
30
+ innerApiCalls: {
31
+ [name: string]: Function;
32
+ };
33
+ pathTemplates: {
34
+ [name: string]: gax.PathTemplate;
35
+ };
36
+ operationsClient: gax.OperationsClient;
37
+ databaseAdminStub?: Promise<{
38
+ [name: string]: Function;
39
+ }>;
40
+ /**
41
+ * Construct an instance of DatabaseAdminClient.
42
+ *
43
+ * @param {object} [options] - The configuration object.
44
+ * The options accepted by the constructor are described in detail
45
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
46
+ * The common options are:
47
+ * @param {object} [options.credentials] - Credentials object.
48
+ * @param {string} [options.credentials.client_email]
49
+ * @param {string} [options.credentials.private_key]
50
+ * @param {string} [options.email] - Account email address. Required when
51
+ * using a .pem or .p12 keyFilename.
52
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
53
+ * .p12 key downloaded from the Google Developers Console. If you provide
54
+ * a path to a JSON file, the projectId option below is not necessary.
55
+ * NOTE: .pem and .p12 require you to specify options.email as well.
56
+ * @param {number} [options.port] - The port on which to connect to
57
+ * the remote host.
58
+ * @param {string} [options.projectId] - The project ID from the Google
59
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
60
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
61
+ * app is running in an environment which supports
62
+ * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
63
+ * your project ID will be detected automatically.
64
+ * @param {string} [options.apiEndpoint] - The domain name of the
65
+ * API remote host.
66
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
67
+ * Follows the structure of {@link gapicConfig}.
68
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
69
+ * For more information, please check the
70
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
71
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
72
+ * need to avoid loading the default gRPC version and want to use the fallback
73
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
74
+ * ```
75
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
76
+ * const client = new DatabaseAdminClient({fallback: true}, gax);
77
+ * ```
78
+ */
79
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
80
+ /**
81
+ * Initialize the client.
82
+ * Performs asynchronous operations (such as authentication) and prepares the client.
83
+ * This function will be called automatically when any class method is called for the
84
+ * first time, but if you need to initialize it before calling an actual method,
85
+ * feel free to call initialize() directly.
86
+ *
87
+ * You can await on this method if you want to make sure the client is initialized.
88
+ *
89
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
90
+ */
91
+ initialize(): Promise<{
92
+ [name: string]: Function;
93
+ }>;
94
+ /**
95
+ * The DNS address for this API service.
96
+ * @deprecated Use the apiEndpoint method of the client instance.
97
+ * @returns {string} The DNS address for this service.
98
+ */
99
+ static get servicePath(): string;
100
+ /**
101
+ * The DNS address for this API service - same as servicePath.
102
+ * @deprecated Use the apiEndpoint method of the client instance.
103
+ * @returns {string} The DNS address for this service.
104
+ */
105
+ static get apiEndpoint(): string;
106
+ /**
107
+ * The DNS address for this API service.
108
+ * @returns {string} The DNS address for this service.
109
+ */
110
+ get apiEndpoint(): string;
111
+ get universeDomain(): string;
112
+ /**
113
+ * The port for this API service.
114
+ * @returns {number} The default port for this service.
115
+ */
116
+ static get port(): number;
117
+ /**
118
+ * The scopes needed to make gRPC calls for every method defined
119
+ * in this service.
120
+ * @returns {string[]} List of default scopes.
121
+ */
122
+ static get scopes(): string[];
123
+ getProjectId(): Promise<string>;
124
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
125
+ /**
126
+ * Gets the state of a Cloud Spanner database.
127
+ *
128
+ * @param {Object} request
129
+ * The request object that will be sent.
130
+ * @param {string} request.name
131
+ * Required. The name of the requested database. Values are of the form
132
+ * `projects/<project>/instances/<instance>/databases/<database>`.
133
+ * @param {object} [options]
134
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
135
+ * @returns {Promise} - The promise which resolves to an array.
136
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.Database|Database}.
137
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
138
+ * for more details and examples.
139
+ * @example <caption>include:samples/generated/v1/database_admin.get_database.js</caption>
140
+ * region_tag:spanner_v1_generated_DatabaseAdmin_GetDatabase_async
141
+ */
142
+ getDatabase(request?: protos.google.spanner.admin.database.v1.IGetDatabaseRequest, options?: CallOptions): Promise<[
143
+ protos.google.spanner.admin.database.v1.IDatabase,
144
+ protos.google.spanner.admin.database.v1.IGetDatabaseRequest | undefined,
145
+ {} | undefined
146
+ ]>;
147
+ getDatabase(request: protos.google.spanner.admin.database.v1.IGetDatabaseRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IGetDatabaseRequest | null | undefined, {} | null | undefined>): void;
148
+ getDatabase(request: protos.google.spanner.admin.database.v1.IGetDatabaseRequest, callback: Callback<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IGetDatabaseRequest | null | undefined, {} | null | undefined>): void;
149
+ /**
150
+ * Drops (aka deletes) a Cloud Spanner database.
151
+ * Completed backups for the database will be retained according to their
152
+ * `expire_time`.
153
+ * Note: Cloud Spanner might continue to accept requests for a few seconds
154
+ * after the database has been deleted.
155
+ *
156
+ * @param {Object} request
157
+ * The request object that will be sent.
158
+ * @param {string} request.database
159
+ * Required. The database to be dropped.
160
+ * @param {object} [options]
161
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
162
+ * @returns {Promise} - The promise which resolves to an array.
163
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
164
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
165
+ * for more details and examples.
166
+ * @example <caption>include:samples/generated/v1/database_admin.drop_database.js</caption>
167
+ * region_tag:spanner_v1_generated_DatabaseAdmin_DropDatabase_async
168
+ */
169
+ dropDatabase(request?: protos.google.spanner.admin.database.v1.IDropDatabaseRequest, options?: CallOptions): Promise<[
170
+ protos.google.protobuf.IEmpty,
171
+ protos.google.spanner.admin.database.v1.IDropDatabaseRequest | undefined,
172
+ {} | undefined
173
+ ]>;
174
+ dropDatabase(request: protos.google.spanner.admin.database.v1.IDropDatabaseRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDropDatabaseRequest | null | undefined, {} | null | undefined>): void;
175
+ dropDatabase(request: protos.google.spanner.admin.database.v1.IDropDatabaseRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDropDatabaseRequest | null | undefined, {} | null | undefined>): void;
176
+ /**
177
+ * Returns the schema of a Cloud Spanner database as a list of formatted
178
+ * DDL statements. This method does not show pending schema updates, those may
179
+ * be queried using the {@link protos.google.longrunning.Operations|Operations} API.
180
+ *
181
+ * @param {Object} request
182
+ * The request object that will be sent.
183
+ * @param {string} request.database
184
+ * Required. The database whose schema we wish to get.
185
+ * Values are of the form
186
+ * `projects/<project>/instances/<instance>/databases/<database>`
187
+ * @param {object} [options]
188
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
189
+ * @returns {Promise} - The promise which resolves to an array.
190
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.GetDatabaseDdlResponse|GetDatabaseDdlResponse}.
191
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
192
+ * for more details and examples.
193
+ * @example <caption>include:samples/generated/v1/database_admin.get_database_ddl.js</caption>
194
+ * region_tag:spanner_v1_generated_DatabaseAdmin_GetDatabaseDdl_async
195
+ */
196
+ getDatabaseDdl(request?: protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest, options?: CallOptions): Promise<[
197
+ protos.google.spanner.admin.database.v1.IGetDatabaseDdlResponse,
198
+ (protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest | undefined),
199
+ {} | undefined
200
+ ]>;
201
+ getDatabaseDdl(request: protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IGetDatabaseDdlResponse, protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest | null | undefined, {} | null | undefined>): void;
202
+ getDatabaseDdl(request: protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest, callback: Callback<protos.google.spanner.admin.database.v1.IGetDatabaseDdlResponse, protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest | null | undefined, {} | null | undefined>): void;
203
+ /**
204
+ * Sets the access control policy on a database or backup resource.
205
+ * Replaces any existing policy.
206
+ *
207
+ * Authorization requires `spanner.databases.setIamPolicy`
208
+ * permission on {@link protos.google.iam.v1.SetIamPolicyRequest.resource|resource}.
209
+ * For backups, authorization requires `spanner.backups.setIamPolicy`
210
+ * permission on {@link protos.google.iam.v1.SetIamPolicyRequest.resource|resource}.
211
+ *
212
+ * @param {Object} request
213
+ * The request object that will be sent.
214
+ * @param {string} request.resource
215
+ * REQUIRED: The resource for which the policy is being specified.
216
+ * See the operation documentation for the appropriate value for this field.
217
+ * @param {google.iam.v1.Policy} request.policy
218
+ * REQUIRED: The complete policy to be applied to the `resource`. The size of
219
+ * the policy is limited to a few 10s of KB. An empty policy is a
220
+ * valid policy but certain Cloud Platform services (such as Projects)
221
+ * might reject them.
222
+ * @param {google.protobuf.FieldMask} request.updateMask
223
+ * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
224
+ * the fields in the mask will be modified. If no mask is provided, the
225
+ * following default mask is used:
226
+ *
227
+ * `paths: "bindings, etag"`
228
+ * @param {object} [options]
229
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
230
+ * @returns {Promise} - The promise which resolves to an array.
231
+ * The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
232
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
233
+ * for more details and examples.
234
+ * @example <caption>include:samples/generated/v1/database_admin.set_iam_policy.js</caption>
235
+ * region_tag:spanner_v1_generated_DatabaseAdmin_SetIamPolicy_async
236
+ */
237
+ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
238
+ protos.google.iam.v1.IPolicy,
239
+ protos.google.iam.v1.ISetIamPolicyRequest | undefined,
240
+ {} | undefined
241
+ ]>;
242
+ setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
243
+ setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
244
+ /**
245
+ * Gets the access control policy for a database or backup resource.
246
+ * Returns an empty policy if a database or backup exists but does not have a
247
+ * policy set.
248
+ *
249
+ * Authorization requires `spanner.databases.getIamPolicy` permission on
250
+ * {@link protos.google.iam.v1.GetIamPolicyRequest.resource|resource}.
251
+ * For backups, authorization requires `spanner.backups.getIamPolicy`
252
+ * permission on {@link protos.google.iam.v1.GetIamPolicyRequest.resource|resource}.
253
+ *
254
+ * @param {Object} request
255
+ * The request object that will be sent.
256
+ * @param {string} request.resource
257
+ * REQUIRED: The resource for which the policy is being requested.
258
+ * See the operation documentation for the appropriate value for this field.
259
+ * @param {google.iam.v1.GetPolicyOptions} request.options
260
+ * OPTIONAL: A `GetPolicyOptions` object for specifying options to
261
+ * `GetIamPolicy`.
262
+ * @param {object} [options]
263
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
264
+ * @returns {Promise} - The promise which resolves to an array.
265
+ * The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
266
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
267
+ * for more details and examples.
268
+ * @example <caption>include:samples/generated/v1/database_admin.get_iam_policy.js</caption>
269
+ * region_tag:spanner_v1_generated_DatabaseAdmin_GetIamPolicy_async
270
+ */
271
+ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
272
+ protos.google.iam.v1.IPolicy,
273
+ protos.google.iam.v1.IGetIamPolicyRequest | undefined,
274
+ {} | undefined
275
+ ]>;
276
+ getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
277
+ getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
278
+ /**
279
+ * Returns permissions that the caller has on the specified database or backup
280
+ * resource.
281
+ *
282
+ * Attempting this RPC on a non-existent Cloud Spanner database will
283
+ * result in a NOT_FOUND error if the user has
284
+ * `spanner.databases.list` permission on the containing Cloud
285
+ * Spanner instance. Otherwise returns an empty set of permissions.
286
+ * Calling this method on a backup that does not exist will
287
+ * result in a NOT_FOUND error if the user has
288
+ * `spanner.backups.list` permission on the containing instance.
289
+ *
290
+ * @param {Object} request
291
+ * The request object that will be sent.
292
+ * @param {string} request.resource
293
+ * REQUIRED: The resource for which the policy detail is being requested.
294
+ * See the operation documentation for the appropriate value for this field.
295
+ * @param {string[]} request.permissions
296
+ * The set of permissions to check for the `resource`. Permissions with
297
+ * wildcards (such as '*' or 'storage.*') are not allowed. For more
298
+ * information see
299
+ * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
300
+ * @param {object} [options]
301
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
302
+ * @returns {Promise} - The promise which resolves to an array.
303
+ * The first element of the array is an object representing {@link protos.google.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}.
304
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
305
+ * for more details and examples.
306
+ * @example <caption>include:samples/generated/v1/database_admin.test_iam_permissions.js</caption>
307
+ * region_tag:spanner_v1_generated_DatabaseAdmin_TestIamPermissions_async
308
+ */
309
+ testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
310
+ protos.google.iam.v1.ITestIamPermissionsResponse,
311
+ protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
312
+ {} | undefined
313
+ ]>;
314
+ testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
315
+ testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
316
+ /**
317
+ * Gets metadata on a pending or completed
318
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
319
+ *
320
+ * @param {Object} request
321
+ * The request object that will be sent.
322
+ * @param {string} request.name
323
+ * Required. Name of the backup.
324
+ * Values are of the form
325
+ * `projects/<project>/instances/<instance>/backups/<backup>`.
326
+ * @param {object} [options]
327
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
328
+ * @returns {Promise} - The promise which resolves to an array.
329
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
330
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
331
+ * for more details and examples.
332
+ * @example <caption>include:samples/generated/v1/database_admin.get_backup.js</caption>
333
+ * region_tag:spanner_v1_generated_DatabaseAdmin_GetBackup_async
334
+ */
335
+ getBackup(request?: protos.google.spanner.admin.database.v1.IGetBackupRequest, options?: CallOptions): Promise<[
336
+ protos.google.spanner.admin.database.v1.IBackup,
337
+ protos.google.spanner.admin.database.v1.IGetBackupRequest | undefined,
338
+ {} | undefined
339
+ ]>;
340
+ getBackup(request: protos.google.spanner.admin.database.v1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
341
+ getBackup(request: protos.google.spanner.admin.database.v1.IGetBackupRequest, callback: Callback<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
342
+ /**
343
+ * Updates a pending or completed
344
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
345
+ *
346
+ * @param {Object} request
347
+ * The request object that will be sent.
348
+ * @param {google.spanner.admin.database.v1.Backup} request.backup
349
+ * Required. The backup to update. `backup.name`, and the fields to be updated
350
+ * as specified by `update_mask` are required. Other fields are ignored.
351
+ * Update is only supported for the following fields:
352
+ * * `backup.expire_time`.
353
+ * @param {google.protobuf.FieldMask} request.updateMask
354
+ * Required. A mask specifying which fields (e.g. `expire_time`) in the
355
+ * Backup resource should be updated. This mask is relative to the Backup
356
+ * resource, not to the request message. The field mask must always be
357
+ * specified; this prevents any future fields from being erased accidentally
358
+ * by clients that do not know about them.
359
+ * @param {object} [options]
360
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
361
+ * @returns {Promise} - The promise which resolves to an array.
362
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
363
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
364
+ * for more details and examples.
365
+ * @example <caption>include:samples/generated/v1/database_admin.update_backup.js</caption>
366
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateBackup_async
367
+ */
368
+ updateBackup(request?: protos.google.spanner.admin.database.v1.IUpdateBackupRequest, options?: CallOptions): Promise<[
369
+ protos.google.spanner.admin.database.v1.IBackup,
370
+ protos.google.spanner.admin.database.v1.IUpdateBackupRequest | undefined,
371
+ {} | undefined
372
+ ]>;
373
+ updateBackup(request: protos.google.spanner.admin.database.v1.IUpdateBackupRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.IUpdateBackupRequest | null | undefined, {} | null | undefined>): void;
374
+ updateBackup(request: protos.google.spanner.admin.database.v1.IUpdateBackupRequest, callback: Callback<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.IUpdateBackupRequest | null | undefined, {} | null | undefined>): void;
375
+ /**
376
+ * Deletes a pending or completed
377
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
378
+ *
379
+ * @param {Object} request
380
+ * The request object that will be sent.
381
+ * @param {string} request.name
382
+ * Required. Name of the backup to delete.
383
+ * Values are of the form
384
+ * `projects/<project>/instances/<instance>/backups/<backup>`.
385
+ * @param {object} [options]
386
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
387
+ * @returns {Promise} - The promise which resolves to an array.
388
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
389
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
390
+ * for more details and examples.
391
+ * @example <caption>include:samples/generated/v1/database_admin.delete_backup.js</caption>
392
+ * region_tag:spanner_v1_generated_DatabaseAdmin_DeleteBackup_async
393
+ */
394
+ deleteBackup(request?: protos.google.spanner.admin.database.v1.IDeleteBackupRequest, options?: CallOptions): Promise<[
395
+ protos.google.protobuf.IEmpty,
396
+ protos.google.spanner.admin.database.v1.IDeleteBackupRequest | undefined,
397
+ {} | undefined
398
+ ]>;
399
+ deleteBackup(request: protos.google.spanner.admin.database.v1.IDeleteBackupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDeleteBackupRequest | null | undefined, {} | null | undefined>): void;
400
+ deleteBackup(request: protos.google.spanner.admin.database.v1.IDeleteBackupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDeleteBackupRequest | null | undefined, {} | null | undefined>): void;
401
+ /**
402
+ * Adds split points to specified tables, indexes of a database.
403
+ *
404
+ * @param {Object} request
405
+ * The request object that will be sent.
406
+ * @param {string} request.database
407
+ * Required. The database on whose tables/indexes split points are to be
408
+ * added. Values are of the form
409
+ * `projects/<project>/instances/<instance>/databases/<database>`.
410
+ * @param {number[]} request.splitPoints
411
+ * Required. The split points to add.
412
+ * @param {string} [request.initiator]
413
+ * Optional. A user-supplied tag associated with the split points.
414
+ * For example, "intital_data_load", "special_event_1".
415
+ * Defaults to "CloudAddSplitPointsAPI" if not specified.
416
+ * The length of the tag must not exceed 50 characters,else will be trimmed.
417
+ * Only valid UTF8 characters are allowed.
418
+ * @param {object} [options]
419
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
420
+ * @returns {Promise} - The promise which resolves to an array.
421
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.AddSplitPointsResponse|AddSplitPointsResponse}.
422
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
423
+ * for more details and examples.
424
+ * @example <caption>include:samples/generated/v1/database_admin.add_split_points.js</caption>
425
+ * region_tag:spanner_v1_generated_DatabaseAdmin_AddSplitPoints_async
426
+ */
427
+ addSplitPoints(request?: protos.google.spanner.admin.database.v1.IAddSplitPointsRequest, options?: CallOptions): Promise<[
428
+ protos.google.spanner.admin.database.v1.IAddSplitPointsResponse,
429
+ (protos.google.spanner.admin.database.v1.IAddSplitPointsRequest | undefined),
430
+ {} | undefined
431
+ ]>;
432
+ addSplitPoints(request: protos.google.spanner.admin.database.v1.IAddSplitPointsRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IAddSplitPointsResponse, protos.google.spanner.admin.database.v1.IAddSplitPointsRequest | null | undefined, {} | null | undefined>): void;
433
+ addSplitPoints(request: protos.google.spanner.admin.database.v1.IAddSplitPointsRequest, callback: Callback<protos.google.spanner.admin.database.v1.IAddSplitPointsResponse, protos.google.spanner.admin.database.v1.IAddSplitPointsRequest | null | undefined, {} | null | undefined>): void;
434
+ /**
435
+ * Creates a new backup schedule.
436
+ *
437
+ * @param {Object} request
438
+ * The request object that will be sent.
439
+ * @param {string} request.parent
440
+ * Required. The name of the database that this backup schedule applies to.
441
+ * @param {string} request.backupScheduleId
442
+ * Required. The Id to use for the backup schedule. The `backup_schedule_id`
443
+ * appended to `parent` forms the full backup schedule name of the form
444
+ * `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>`.
445
+ * @param {google.spanner.admin.database.v1.BackupSchedule} request.backupSchedule
446
+ * Required. The backup schedule to create.
447
+ * @param {object} [options]
448
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
449
+ * @returns {Promise} - The promise which resolves to an array.
450
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule}.
451
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
452
+ * for more details and examples.
453
+ * @example <caption>include:samples/generated/v1/database_admin.create_backup_schedule.js</caption>
454
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CreateBackupSchedule_async
455
+ */
456
+ createBackupSchedule(request?: protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest, options?: CallOptions): Promise<[
457
+ protos.google.spanner.admin.database.v1.IBackupSchedule,
458
+ (protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest | undefined),
459
+ {} | undefined
460
+ ]>;
461
+ createBackupSchedule(request: protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
462
+ createBackupSchedule(request: protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.ICreateBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
463
+ /**
464
+ * Gets backup schedule for the input schedule name.
465
+ *
466
+ * @param {Object} request
467
+ * The request object that will be sent.
468
+ * @param {string} request.name
469
+ * Required. The name of the schedule to retrieve.
470
+ * Values are of the form
471
+ * `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>`.
472
+ * @param {object} [options]
473
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
474
+ * @returns {Promise} - The promise which resolves to an array.
475
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule}.
476
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
477
+ * for more details and examples.
478
+ * @example <caption>include:samples/generated/v1/database_admin.get_backup_schedule.js</caption>
479
+ * region_tag:spanner_v1_generated_DatabaseAdmin_GetBackupSchedule_async
480
+ */
481
+ getBackupSchedule(request?: protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest, options?: CallOptions): Promise<[
482
+ protos.google.spanner.admin.database.v1.IBackupSchedule,
483
+ (protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest | undefined),
484
+ {} | undefined
485
+ ]>;
486
+ getBackupSchedule(request: protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
487
+ getBackupSchedule(request: protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.IGetBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
488
+ /**
489
+ * Updates a backup schedule.
490
+ *
491
+ * @param {Object} request
492
+ * The request object that will be sent.
493
+ * @param {google.spanner.admin.database.v1.BackupSchedule} request.backupSchedule
494
+ * Required. The backup schedule to update. `backup_schedule.name`, and the
495
+ * fields to be updated as specified by `update_mask` are required. Other
496
+ * fields are ignored.
497
+ * @param {google.protobuf.FieldMask} request.updateMask
498
+ * Required. A mask specifying which fields in the BackupSchedule resource
499
+ * should be updated. This mask is relative to the BackupSchedule resource,
500
+ * not to the request message. The field mask must always be
501
+ * specified; this prevents any future fields from being erased
502
+ * accidentally.
503
+ * @param {object} [options]
504
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
505
+ * @returns {Promise} - The promise which resolves to an array.
506
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule}.
507
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
508
+ * for more details and examples.
509
+ * @example <caption>include:samples/generated/v1/database_admin.update_backup_schedule.js</caption>
510
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateBackupSchedule_async
511
+ */
512
+ updateBackupSchedule(request?: protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest, options?: CallOptions): Promise<[
513
+ protos.google.spanner.admin.database.v1.IBackupSchedule,
514
+ (protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest | undefined),
515
+ {} | undefined
516
+ ]>;
517
+ updateBackupSchedule(request: protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
518
+ updateBackupSchedule(request: protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest, callback: Callback<protos.google.spanner.admin.database.v1.IBackupSchedule, protos.google.spanner.admin.database.v1.IUpdateBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
519
+ /**
520
+ * Deletes a backup schedule.
521
+ *
522
+ * @param {Object} request
523
+ * The request object that will be sent.
524
+ * @param {string} request.name
525
+ * Required. The name of the schedule to delete.
526
+ * Values are of the form
527
+ * `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>`.
528
+ * @param {object} [options]
529
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
530
+ * @returns {Promise} - The promise which resolves to an array.
531
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
532
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
533
+ * for more details and examples.
534
+ * @example <caption>include:samples/generated/v1/database_admin.delete_backup_schedule.js</caption>
535
+ * region_tag:spanner_v1_generated_DatabaseAdmin_DeleteBackupSchedule_async
536
+ */
537
+ deleteBackupSchedule(request?: protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest, options?: CallOptions): Promise<[
538
+ protos.google.protobuf.IEmpty,
539
+ (protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest | undefined),
540
+ {} | undefined
541
+ ]>;
542
+ deleteBackupSchedule(request: protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
543
+ deleteBackupSchedule(request: protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IDeleteBackupScheduleRequest | null | undefined, {} | null | undefined>): void;
544
+ /**
545
+ * This is an internal API called by Spanner Graph jobs. You should never need
546
+ * to call this API directly.
547
+ *
548
+ * @param {Object} request
549
+ * The request object that will be sent.
550
+ * @param {string} request.database
551
+ * Internal field, do not use directly.
552
+ * @param {string} request.operationId
553
+ * Internal field, do not use directly.
554
+ * @param {string} request.vmIdentityToken
555
+ * Internal field, do not use directly.
556
+ * @param {number} [request.progress]
557
+ * Internal field, do not use directly.
558
+ * @param {google.rpc.Status} [request.status]
559
+ * Internal field, do not use directly.
560
+ * @param {object} [options]
561
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
562
+ * @returns {Promise} - The promise which resolves to an array.
563
+ * The first element of the array is an object representing {@link protos.google.spanner.admin.database.v1.InternalUpdateGraphOperationResponse|InternalUpdateGraphOperationResponse}.
564
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
565
+ * for more details and examples.
566
+ * @example <caption>include:samples/generated/v1/database_admin.internal_update_graph_operation.js</caption>
567
+ * region_tag:spanner_v1_generated_DatabaseAdmin_InternalUpdateGraphOperation_async
568
+ */
569
+ internalUpdateGraphOperation(request?: protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest, options?: CallOptions): Promise<[
570
+ protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationResponse,
571
+ (protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest | undefined),
572
+ {} | undefined
573
+ ]>;
574
+ internalUpdateGraphOperation(request: protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest, options: CallOptions, callback: Callback<protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationResponse, protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest | null | undefined, {} | null | undefined>): void;
575
+ internalUpdateGraphOperation(request: protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest, callback: Callback<protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationResponse, protos.google.spanner.admin.database.v1.IInternalUpdateGraphOperationRequest | null | undefined, {} | null | undefined>): void;
576
+ /**
577
+ * Creates a new Cloud Spanner database and starts to prepare it for serving.
578
+ * The returned {@link protos.google.longrunning.Operation|long-running operation} will
579
+ * have a name of the format `<database_name>/operations/<operation_id>` and
580
+ * can be used to track preparation of the database. The
581
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type is
582
+ * {@link protos.google.spanner.admin.database.v1.CreateDatabaseMetadata|CreateDatabaseMetadata}.
583
+ * The {@link protos.google.longrunning.Operation.response|response} field type is
584
+ * {@link protos.google.spanner.admin.database.v1.Database|Database}, if successful.
585
+ *
586
+ * @param {Object} request
587
+ * The request object that will be sent.
588
+ * @param {string} request.parent
589
+ * Required. The name of the instance that will serve the new database.
590
+ * Values are of the form `projects/<project>/instances/<instance>`.
591
+ * @param {string} request.createStatement
592
+ * Required. A `CREATE DATABASE` statement, which specifies the ID of the
593
+ * new database. The database ID must conform to the regular expression
594
+ * `{@link protos.a-z0-9_\-|a-z}*[a-z0-9]` and be between 2 and 30 characters in length.
595
+ * If the database ID is a reserved word or if it contains a hyphen, the
596
+ * database ID must be enclosed in backticks (`` ` ``).
597
+ * @param {string[]} [request.extraStatements]
598
+ * Optional. A list of DDL statements to run inside the newly created
599
+ * database. Statements can create tables, indexes, etc. These
600
+ * statements execute atomically with the creation of the database:
601
+ * if there is an error in any statement, the database is not created.
602
+ * @param {google.spanner.admin.database.v1.EncryptionConfig} [request.encryptionConfig]
603
+ * Optional. The encryption configuration for the database. If this field is
604
+ * not specified, Cloud Spanner will encrypt/decrypt all data at rest using
605
+ * Google default encryption.
606
+ * @param {google.spanner.admin.database.v1.DatabaseDialect} [request.databaseDialect]
607
+ * Optional. The dialect of the Cloud Spanner Database.
608
+ * @param {Buffer} [request.protoDescriptors]
609
+ * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in
610
+ * 'extra_statements' above.
611
+ * Contains a protobuf-serialized
612
+ * [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
613
+ * To generate it, [install](https://grpc.io/docs/protoc-installation/) and
614
+ * run `protoc` with --include_imports and --descriptor_set_out. For example,
615
+ * to generate for moon/shot/app.proto, run
616
+ * ```
617
+ * $protoc --proto_path=/app_path --proto_path=/lib_path \
618
+ * --include_imports \
619
+ * --descriptor_set_out=descriptors.data \
620
+ * moon/shot/app.proto
621
+ * ```
622
+ * For more details, see protobuffer [self
623
+ * description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
624
+ * @param {object} [options]
625
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
626
+ * @returns {Promise} - The promise which resolves to an array.
627
+ * The first element of the array is an object representing
628
+ * a long running operation. Its `promise()` method returns a promise
629
+ * you can `await` for.
630
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
631
+ * for more details and examples.
632
+ * @example <caption>include:samples/generated/v1/database_admin.create_database.js</caption>
633
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CreateDatabase_async
634
+ */
635
+ createDatabase(request?: protos.google.spanner.admin.database.v1.ICreateDatabaseRequest, options?: CallOptions): Promise<[
636
+ LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.ICreateDatabaseMetadata>,
637
+ protos.google.longrunning.IOperation | undefined,
638
+ {} | undefined
639
+ ]>;
640
+ createDatabase(request: protos.google.spanner.admin.database.v1.ICreateDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.ICreateDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
641
+ createDatabase(request: protos.google.spanner.admin.database.v1.ICreateDatabaseRequest, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.ICreateDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
642
+ /**
643
+ * Check the status of the long running operation returned by `createDatabase()`.
644
+ * @param {String} name
645
+ * The operation name that will be passed.
646
+ * @returns {Promise} - The promise which resolves to an object.
647
+ * The decoded operation object has result and metadata field to get information from.
648
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
649
+ * for more details and examples.
650
+ * @example <caption>include:samples/generated/v1/database_admin.create_database.js</caption>
651
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CreateDatabase_async
652
+ */
653
+ checkCreateDatabaseProgress(name: string): Promise<LROperation<protos.google.spanner.admin.database.v1.Database, protos.google.spanner.admin.database.v1.CreateDatabaseMetadata>>;
654
+ /**
655
+ * Updates a Cloud Spanner database. The returned
656
+ * {@link protos.google.longrunning.Operation|long-running operation} can be used to track
657
+ * the progress of updating the database. If the named database does not
658
+ * exist, returns `NOT_FOUND`.
659
+ *
660
+ * While the operation is pending:
661
+ *
662
+ * * The database's
663
+ * {@link protos.google.spanner.admin.database.v1.Database.reconciling|reconciling}
664
+ * field is set to true.
665
+ * * Cancelling the operation is best-effort. If the cancellation succeeds,
666
+ * the operation metadata's
667
+ * {@link protos.google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time|cancel_time}
668
+ * is set, the updates are reverted, and the operation terminates with a
669
+ * `CANCELLED` status.
670
+ * * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error
671
+ * until the pending operation is done (returns successfully or with
672
+ * error).
673
+ * * Reading the database via the API continues to give the pre-request
674
+ * values.
675
+ *
676
+ * Upon completion of the returned operation:
677
+ *
678
+ * * The new values are in effect and readable via the API.
679
+ * * The database's
680
+ * {@link protos.google.spanner.admin.database.v1.Database.reconciling|reconciling}
681
+ * field becomes false.
682
+ *
683
+ * The returned {@link protos.google.longrunning.Operation|long-running operation} will
684
+ * have a name of the format
685
+ * `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`
686
+ * and can be used to track the database modification. The
687
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type is
688
+ * {@link protos.google.spanner.admin.database.v1.UpdateDatabaseMetadata|UpdateDatabaseMetadata}.
689
+ * The {@link protos.google.longrunning.Operation.response|response} field type is
690
+ * {@link protos.google.spanner.admin.database.v1.Database|Database}, if successful.
691
+ *
692
+ * @param {Object} request
693
+ * The request object that will be sent.
694
+ * @param {google.spanner.admin.database.v1.Database} request.database
695
+ * Required. The database to update.
696
+ * The `name` field of the database is of the form
697
+ * `projects/<project>/instances/<instance>/databases/<database>`.
698
+ * @param {google.protobuf.FieldMask} request.updateMask
699
+ * Required. The list of fields to update. Currently, only
700
+ * `enable_drop_protection` field can be updated.
701
+ * @param {object} [options]
702
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
703
+ * @returns {Promise} - The promise which resolves to an array.
704
+ * The first element of the array is an object representing
705
+ * a long running operation. Its `promise()` method returns a promise
706
+ * you can `await` for.
707
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
708
+ * for more details and examples.
709
+ * @example <caption>include:samples/generated/v1/database_admin.update_database.js</caption>
710
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateDatabase_async
711
+ */
712
+ updateDatabase(request?: protos.google.spanner.admin.database.v1.IUpdateDatabaseRequest, options?: CallOptions): Promise<[
713
+ LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IUpdateDatabaseMetadata>,
714
+ protos.google.longrunning.IOperation | undefined,
715
+ {} | undefined
716
+ ]>;
717
+ updateDatabase(request: protos.google.spanner.admin.database.v1.IUpdateDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IUpdateDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
718
+ updateDatabase(request: protos.google.spanner.admin.database.v1.IUpdateDatabaseRequest, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IUpdateDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
719
+ /**
720
+ * Check the status of the long running operation returned by `updateDatabase()`.
721
+ * @param {String} name
722
+ * The operation name that will be passed.
723
+ * @returns {Promise} - The promise which resolves to an object.
724
+ * The decoded operation object has result and metadata field to get information from.
725
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
726
+ * for more details and examples.
727
+ * @example <caption>include:samples/generated/v1/database_admin.update_database.js</caption>
728
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateDatabase_async
729
+ */
730
+ checkUpdateDatabaseProgress(name: string): Promise<LROperation<protos.google.spanner.admin.database.v1.Database, protos.google.spanner.admin.database.v1.UpdateDatabaseMetadata>>;
731
+ /**
732
+ * Updates the schema of a Cloud Spanner database by
733
+ * creating/altering/dropping tables, columns, indexes, etc. The returned
734
+ * {@link protos.google.longrunning.Operation|long-running operation} will have a name of
735
+ * the format `<database_name>/operations/<operation_id>` and can be used to
736
+ * track execution of the schema change(s). The
737
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type is
738
+ * {@link protos.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata|UpdateDatabaseDdlMetadata}.
739
+ * The operation has no response.
740
+ *
741
+ * @param {Object} request
742
+ * The request object that will be sent.
743
+ * @param {string} request.database
744
+ * Required. The database to update.
745
+ * @param {string[]} request.statements
746
+ * Required. DDL statements to be applied to the database.
747
+ * @param {string} request.operationId
748
+ * If empty, the new update request is assigned an
749
+ * automatically-generated operation ID. Otherwise, `operation_id`
750
+ * is used to construct the name of the resulting
751
+ * {@link protos.google.longrunning.Operation|Operation}.
752
+ *
753
+ * Specifying an explicit operation ID simplifies determining
754
+ * whether the statements were executed in the event that the
755
+ * {@link protos.google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl|UpdateDatabaseDdl}
756
+ * call is replayed, or the return value is otherwise lost: the
757
+ * {@link protos.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database|database}
758
+ * and `operation_id` fields can be combined to form the
759
+ * {@link protos.google.longrunning.Operation.name|name} of the resulting
760
+ * {@link protos.google.longrunning.Operation|longrunning.Operation}:
761
+ * `<database>/operations/<operation_id>`.
762
+ *
763
+ * `operation_id` should be unique within the database, and must be
764
+ * a valid identifier: `{@link protos.a-z0-9_|a-z}*`. Note that
765
+ * automatically-generated operation IDs always begin with an
766
+ * underscore. If the named operation already exists,
767
+ * {@link protos.google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl|UpdateDatabaseDdl}
768
+ * returns `ALREADY_EXISTS`.
769
+ * @param {Buffer} [request.protoDescriptors]
770
+ * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
771
+ * Contains a protobuf-serialized
772
+ * [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
773
+ * To generate it, [install](https://grpc.io/docs/protoc-installation/) and
774
+ * run `protoc` with --include_imports and --descriptor_set_out. For example,
775
+ * to generate for moon/shot/app.proto, run
776
+ * ```
777
+ * $protoc --proto_path=/app_path --proto_path=/lib_path \
778
+ * --include_imports \
779
+ * --descriptor_set_out=descriptors.data \
780
+ * moon/shot/app.proto
781
+ * ```
782
+ * For more details, see protobuffer [self
783
+ * description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
784
+ * @param {boolean} [request.throughputMode]
785
+ * Optional. This field is exposed to be used by the Spanner Migration Tool.
786
+ * For more details, see
787
+ * [SMT](https://github.com/GoogleCloudPlatform/spanner-migration-tool).
788
+ * @param {object} [options]
789
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
790
+ * @returns {Promise} - The promise which resolves to an array.
791
+ * The first element of the array is an object representing
792
+ * a long running operation. Its `promise()` method returns a promise
793
+ * you can `await` for.
794
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
795
+ * for more details and examples.
796
+ * @example <caption>include:samples/generated/v1/database_admin.update_database_ddl.js</caption>
797
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_async
798
+ */
799
+ updateDatabaseDdl(request?: protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest, options?: CallOptions): Promise<[
800
+ LROperation<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata>,
801
+ protos.google.longrunning.IOperation | undefined,
802
+ {} | undefined
803
+ ]>;
804
+ updateDatabaseDdl(request: protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
805
+ updateDatabaseDdl(request: protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
806
+ /**
807
+ * Check the status of the long running operation returned by `updateDatabaseDdl()`.
808
+ * @param {String} name
809
+ * The operation name that will be passed.
810
+ * @returns {Promise} - The promise which resolves to an object.
811
+ * The decoded operation object has result and metadata field to get information from.
812
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
813
+ * for more details and examples.
814
+ * @example <caption>include:samples/generated/v1/database_admin.update_database_ddl.js</caption>
815
+ * region_tag:spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_async
816
+ */
817
+ checkUpdateDatabaseDdlProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>>;
818
+ /**
819
+ * Starts creating a new Cloud Spanner Backup.
820
+ * The returned backup {@link protos.google.longrunning.Operation|long-running operation}
821
+ * will have a name of the format
822
+ * `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
823
+ * and can be used to track creation of the backup. The
824
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type is
825
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
826
+ * The {@link protos.google.longrunning.Operation.response|response} field type is
827
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}, if successful.
828
+ * Cancelling the returned operation will stop the creation and delete the
829
+ * backup. There can be only one pending backup creation per database. Backup
830
+ * creation of different databases can run concurrently.
831
+ *
832
+ * @param {Object} request
833
+ * The request object that will be sent.
834
+ * @param {string} request.parent
835
+ * Required. The name of the instance in which the backup will be
836
+ * created. This must be the same instance that contains the database the
837
+ * backup will be created from. The backup will be stored in the
838
+ * location(s) specified in the instance configuration of this
839
+ * instance. Values are of the form
840
+ * `projects/<project>/instances/<instance>`.
841
+ * @param {string} request.backupId
842
+ * Required. The id of the backup to be created. The `backup_id` appended to
843
+ * `parent` forms the full backup name of the form
844
+ * `projects/<project>/instances/<instance>/backups/<backup_id>`.
845
+ * @param {google.spanner.admin.database.v1.Backup} request.backup
846
+ * Required. The backup to create.
847
+ * @param {google.spanner.admin.database.v1.CreateBackupEncryptionConfig} [request.encryptionConfig]
848
+ * Optional. The encryption configuration used to encrypt the backup. If this
849
+ * field is not specified, the backup will use the same encryption
850
+ * configuration as the database by default, namely
851
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type|encryption_type}
852
+ * = `USE_DATABASE_ENCRYPTION`.
853
+ * @param {object} [options]
854
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
855
+ * @returns {Promise} - The promise which resolves to an array.
856
+ * The first element of the array is an object representing
857
+ * a long running operation. Its `promise()` method returns a promise
858
+ * you can `await` for.
859
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
860
+ * for more details and examples.
861
+ * @example <caption>include:samples/generated/v1/database_admin.create_backup.js</caption>
862
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CreateBackup_async
863
+ */
864
+ createBackup(request?: protos.google.spanner.admin.database.v1.ICreateBackupRequest, options?: CallOptions): Promise<[
865
+ LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICreateBackupMetadata>,
866
+ protos.google.longrunning.IOperation | undefined,
867
+ {} | undefined
868
+ ]>;
869
+ createBackup(request: protos.google.spanner.admin.database.v1.ICreateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICreateBackupMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
870
+ createBackup(request: protos.google.spanner.admin.database.v1.ICreateBackupRequest, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICreateBackupMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
871
+ /**
872
+ * Check the status of the long running operation returned by `createBackup()`.
873
+ * @param {String} name
874
+ * The operation name that will be passed.
875
+ * @returns {Promise} - The promise which resolves to an object.
876
+ * The decoded operation object has result and metadata field to get information from.
877
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
878
+ * for more details and examples.
879
+ * @example <caption>include:samples/generated/v1/database_admin.create_backup.js</caption>
880
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CreateBackup_async
881
+ */
882
+ checkCreateBackupProgress(name: string): Promise<LROperation<protos.google.spanner.admin.database.v1.Backup, protos.google.spanner.admin.database.v1.CreateBackupMetadata>>;
883
+ /**
884
+ * Starts copying a Cloud Spanner Backup.
885
+ * The returned backup {@link protos.google.longrunning.Operation|long-running operation}
886
+ * will have a name of the format
887
+ * `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
888
+ * and can be used to track copying of the backup. The operation is associated
889
+ * with the destination backup.
890
+ * The {@link protos.google.longrunning.Operation.metadata|metadata} field type is
891
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}.
892
+ * The {@link protos.google.longrunning.Operation.response|response} field type is
893
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}, if successful.
894
+ * Cancelling the returned operation will stop the copying and delete the
895
+ * destination backup. Concurrent CopyBackup requests can run on the same
896
+ * source backup.
897
+ *
898
+ * @param {Object} request
899
+ * The request object that will be sent.
900
+ * @param {string} request.parent
901
+ * Required. The name of the destination instance that will contain the backup
902
+ * copy. Values are of the form: `projects/<project>/instances/<instance>`.
903
+ * @param {string} request.backupId
904
+ * Required. The id of the backup copy.
905
+ * The `backup_id` appended to `parent` forms the full backup_uri of the form
906
+ * `projects/<project>/instances/<instance>/backups/<backup>`.
907
+ * @param {string} request.sourceBackup
908
+ * Required. The source backup to be copied.
909
+ * The source backup needs to be in READY state for it to be copied.
910
+ * Once CopyBackup is in progress, the source backup cannot be deleted or
911
+ * cleaned up on expiration until CopyBackup is finished.
912
+ * Values are of the form:
913
+ * `projects/<project>/instances/<instance>/backups/<backup>`.
914
+ * @param {google.protobuf.Timestamp} request.expireTime
915
+ * Required. The expiration time of the backup in microsecond granularity.
916
+ * The expiration time must be at least 6 hours and at most 366 days
917
+ * from the `create_time` of the source backup. Once the `expire_time` has
918
+ * passed, the backup is eligible to be automatically deleted by Cloud Spanner
919
+ * to free the resources used by the backup.
920
+ * @param {google.spanner.admin.database.v1.CopyBackupEncryptionConfig} [request.encryptionConfig]
921
+ * Optional. The encryption configuration used to encrypt the backup. If this
922
+ * field is not specified, the backup will use the same encryption
923
+ * configuration as the source backup by default, namely
924
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type|encryption_type}
925
+ * = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
926
+ * @param {object} [options]
927
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
928
+ * @returns {Promise} - The promise which resolves to an array.
929
+ * The first element of the array is an object representing
930
+ * a long running operation. Its `promise()` method returns a promise
931
+ * you can `await` for.
932
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
933
+ * for more details and examples.
934
+ * @example <caption>include:samples/generated/v1/database_admin.copy_backup.js</caption>
935
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CopyBackup_async
936
+ */
937
+ copyBackup(request?: protos.google.spanner.admin.database.v1.ICopyBackupRequest, options?: CallOptions): Promise<[
938
+ LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICopyBackupMetadata>,
939
+ protos.google.longrunning.IOperation | undefined,
940
+ {} | undefined
941
+ ]>;
942
+ copyBackup(request: protos.google.spanner.admin.database.v1.ICopyBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICopyBackupMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
943
+ copyBackup(request: protos.google.spanner.admin.database.v1.ICopyBackupRequest, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IBackup, protos.google.spanner.admin.database.v1.ICopyBackupMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
944
+ /**
945
+ * Check the status of the long running operation returned by `copyBackup()`.
946
+ * @param {String} name
947
+ * The operation name that will be passed.
948
+ * @returns {Promise} - The promise which resolves to an object.
949
+ * The decoded operation object has result and metadata field to get information from.
950
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
951
+ * for more details and examples.
952
+ * @example <caption>include:samples/generated/v1/database_admin.copy_backup.js</caption>
953
+ * region_tag:spanner_v1_generated_DatabaseAdmin_CopyBackup_async
954
+ */
955
+ checkCopyBackupProgress(name: string): Promise<LROperation<protos.google.spanner.admin.database.v1.Backup, protos.google.spanner.admin.database.v1.CopyBackupMetadata>>;
956
+ /**
957
+ * Create a new database by restoring from a completed backup. The new
958
+ * database must be in the same project and in an instance with the same
959
+ * instance configuration as the instance containing
960
+ * the backup. The returned database [long-running
961
+ * operation][google.longrunning.Operation] has a name of the format
962
+ * `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`,
963
+ * and can be used to track the progress of the operation, and to cancel it.
964
+ * The {@link protos.google.longrunning.Operation.metadata|metadata} field type is
965
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}.
966
+ * The {@link protos.google.longrunning.Operation.response|response} type
967
+ * is {@link protos.google.spanner.admin.database.v1.Database|Database}, if
968
+ * successful. Cancelling the returned operation will stop the restore and
969
+ * delete the database.
970
+ * There can be only one database being restored into an instance at a time.
971
+ * Once the restore operation completes, a new restore operation can be
972
+ * initiated, without waiting for the optimize operation associated with the
973
+ * first restore to complete.
974
+ *
975
+ * @param {Object} request
976
+ * The request object that will be sent.
977
+ * @param {string} request.parent
978
+ * Required. The name of the instance in which to create the
979
+ * restored database. This instance must be in the same project and
980
+ * have the same instance configuration as the instance containing
981
+ * the source backup. Values are of the form
982
+ * `projects/<project>/instances/<instance>`.
983
+ * @param {string} request.databaseId
984
+ * Required. The id of the database to create and restore to. This
985
+ * database must not already exist. The `database_id` appended to
986
+ * `parent` forms the full database name of the form
987
+ * `projects/<project>/instances/<instance>/databases/<database_id>`.
988
+ * @param {string} request.backup
989
+ * Name of the backup from which to restore. Values are of the form
990
+ * `projects/<project>/instances/<instance>/backups/<backup>`.
991
+ * @param {google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig} [request.encryptionConfig]
992
+ * Optional. An encryption configuration describing the encryption type and
993
+ * key resources in Cloud KMS used to encrypt/decrypt the database to restore
994
+ * to. If this field is not specified, the restored database will use the same
995
+ * encryption configuration as the backup by default, namely
996
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type|encryption_type}
997
+ * = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
998
+ * @param {object} [options]
999
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1000
+ * @returns {Promise} - The promise which resolves to an array.
1001
+ * The first element of the array is an object representing
1002
+ * a long running operation. Its `promise()` method returns a promise
1003
+ * you can `await` for.
1004
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1005
+ * for more details and examples.
1006
+ * @example <caption>include:samples/generated/v1/database_admin.restore_database.js</caption>
1007
+ * region_tag:spanner_v1_generated_DatabaseAdmin_RestoreDatabase_async
1008
+ */
1009
+ restoreDatabase(request?: protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest, options?: CallOptions): Promise<[
1010
+ LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IRestoreDatabaseMetadata>,
1011
+ protos.google.longrunning.IOperation | undefined,
1012
+ {} | undefined
1013
+ ]>;
1014
+ restoreDatabase(request: protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IRestoreDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1015
+ restoreDatabase(request: protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest, callback: Callback<LROperation<protos.google.spanner.admin.database.v1.IDatabase, protos.google.spanner.admin.database.v1.IRestoreDatabaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1016
+ /**
1017
+ * Check the status of the long running operation returned by `restoreDatabase()`.
1018
+ * @param {String} name
1019
+ * The operation name that will be passed.
1020
+ * @returns {Promise} - The promise which resolves to an object.
1021
+ * The decoded operation object has result and metadata field to get information from.
1022
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1023
+ * for more details and examples.
1024
+ * @example <caption>include:samples/generated/v1/database_admin.restore_database.js</caption>
1025
+ * region_tag:spanner_v1_generated_DatabaseAdmin_RestoreDatabase_async
1026
+ */
1027
+ checkRestoreDatabaseProgress(name: string): Promise<LROperation<protos.google.spanner.admin.database.v1.Database, protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata>>;
1028
+ /**
1029
+ * Lists Cloud Spanner databases.
1030
+ *
1031
+ * @param {Object} request
1032
+ * The request object that will be sent.
1033
+ * @param {string} request.parent
1034
+ * Required. The instance whose databases should be listed.
1035
+ * Values are of the form `projects/<project>/instances/<instance>`.
1036
+ * @param {number} request.pageSize
1037
+ * Number of databases to be returned in the response. If 0 or less,
1038
+ * defaults to the server's maximum allowed page size.
1039
+ * @param {string} request.pageToken
1040
+ * If non-empty, `page_token` should contain a
1041
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token|next_page_token}
1042
+ * from a previous
1043
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse|ListDatabasesResponse}.
1044
+ * @param {object} [options]
1045
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1046
+ * @returns {Promise} - The promise which resolves to an array.
1047
+ * The first element of the array is Array of {@link protos.google.spanner.admin.database.v1.Database|Database}.
1048
+ * The client library will perform auto-pagination by default: it will call the API as many
1049
+ * times as needed and will merge results from all the pages into this array.
1050
+ * Note that it can affect your quota.
1051
+ * We recommend using `listDatabasesAsync()`
1052
+ * method described below for async iteration which you can stop as needed.
1053
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1054
+ * for more details and examples.
1055
+ */
1056
+ listDatabases(request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest, options?: CallOptions): Promise<[
1057
+ protos.google.spanner.admin.database.v1.IDatabase[],
1058
+ protos.google.spanner.admin.database.v1.IListDatabasesRequest | null,
1059
+ protos.google.spanner.admin.database.v1.IListDatabasesResponse
1060
+ ]>;
1061
+ listDatabases(request: protos.google.spanner.admin.database.v1.IListDatabasesRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabasesRequest, protos.google.spanner.admin.database.v1.IListDatabasesResponse | null | undefined, protos.google.spanner.admin.database.v1.IDatabase>): void;
1062
+ listDatabases(request: protos.google.spanner.admin.database.v1.IListDatabasesRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabasesRequest, protos.google.spanner.admin.database.v1.IListDatabasesResponse | null | undefined, protos.google.spanner.admin.database.v1.IDatabase>): void;
1063
+ /**
1064
+ * Equivalent to `listDatabases`, but returns a NodeJS Stream object.
1065
+ * @param {Object} request
1066
+ * The request object that will be sent.
1067
+ * @param {string} request.parent
1068
+ * Required. The instance whose databases should be listed.
1069
+ * Values are of the form `projects/<project>/instances/<instance>`.
1070
+ * @param {number} request.pageSize
1071
+ * Number of databases to be returned in the response. If 0 or less,
1072
+ * defaults to the server's maximum allowed page size.
1073
+ * @param {string} request.pageToken
1074
+ * If non-empty, `page_token` should contain a
1075
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token|next_page_token}
1076
+ * from a previous
1077
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse|ListDatabasesResponse}.
1078
+ * @param {object} [options]
1079
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1080
+ * @returns {Stream}
1081
+ * An object stream which emits an object representing {@link protos.google.spanner.admin.database.v1.Database|Database} on 'data' event.
1082
+ * The client library will perform auto-pagination by default: it will call the API as many
1083
+ * times as needed. Note that it can affect your quota.
1084
+ * We recommend using `listDatabasesAsync()`
1085
+ * method described below for async iteration which you can stop as needed.
1086
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1087
+ * for more details and examples.
1088
+ */
1089
+ listDatabasesStream(request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest, options?: CallOptions): Transform;
1090
+ /**
1091
+ * Equivalent to `listDatabases`, but returns an iterable object.
1092
+ *
1093
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1094
+ * @param {Object} request
1095
+ * The request object that will be sent.
1096
+ * @param {string} request.parent
1097
+ * Required. The instance whose databases should be listed.
1098
+ * Values are of the form `projects/<project>/instances/<instance>`.
1099
+ * @param {number} request.pageSize
1100
+ * Number of databases to be returned in the response. If 0 or less,
1101
+ * defaults to the server's maximum allowed page size.
1102
+ * @param {string} request.pageToken
1103
+ * If non-empty, `page_token` should contain a
1104
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token|next_page_token}
1105
+ * from a previous
1106
+ * {@link protos.google.spanner.admin.database.v1.ListDatabasesResponse|ListDatabasesResponse}.
1107
+ * @param {object} [options]
1108
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1109
+ * @returns {Object}
1110
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1111
+ * When you iterate the returned iterable, each element will be an object representing
1112
+ * {@link protos.google.spanner.admin.database.v1.Database|Database}. The API will be called under the hood as needed, once per the page,
1113
+ * so you can stop the iteration when you don't need more results.
1114
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1115
+ * for more details and examples.
1116
+ * @example <caption>include:samples/generated/v1/database_admin.list_databases.js</caption>
1117
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListDatabases_async
1118
+ */
1119
+ listDatabasesAsync(request?: protos.google.spanner.admin.database.v1.IListDatabasesRequest, options?: CallOptions): AsyncIterable<protos.google.spanner.admin.database.v1.IDatabase>;
1120
+ /**
1121
+ * Lists completed and pending backups.
1122
+ * Backups returned are ordered by `create_time` in descending order,
1123
+ * starting from the most recent `create_time`.
1124
+ *
1125
+ * @param {Object} request
1126
+ * The request object that will be sent.
1127
+ * @param {string} request.parent
1128
+ * Required. The instance to list backups from. Values are of the
1129
+ * form `projects/<project>/instances/<instance>`.
1130
+ * @param {string} request.filter
1131
+ * An expression that filters the list of returned backups.
1132
+ *
1133
+ * A filter expression consists of a field name, a comparison operator, and a
1134
+ * value for filtering.
1135
+ * The value must be a string, a number, or a boolean. The comparison operator
1136
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1137
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1138
+ *
1139
+ * The following fields in the
1140
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup} are eligible for
1141
+ * filtering:
1142
+ *
1143
+ * * `name`
1144
+ * * `database`
1145
+ * * `state`
1146
+ * * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1147
+ * * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1148
+ * * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1149
+ * * `size_bytes`
1150
+ * * `backup_schedules`
1151
+ *
1152
+ * You can combine multiple expressions by enclosing each expression in
1153
+ * parentheses. By default, expressions are combined with AND logic, but
1154
+ * you can specify AND, OR, and NOT logic explicitly.
1155
+ *
1156
+ * Here are a few examples:
1157
+ *
1158
+ * * `name:Howl` - The backup's name contains the string "howl".
1159
+ * * `database:prod`
1160
+ * - The database's name contains the string "prod".
1161
+ * * `state:CREATING` - The backup is pending creation.
1162
+ * * `state:READY` - The backup is fully created and ready for use.
1163
+ * * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
1164
+ * - The backup name contains the string "howl" and `create_time`
1165
+ * of the backup is before 2018-03-28T14:50:00Z.
1166
+ * * `expire_time < \"2018-03-28T14:50:00Z\"`
1167
+ * - The backup `expire_time` is before 2018-03-28T14:50:00Z.
1168
+ * * `size_bytes > 10000000000` - The backup's size is greater than 10GB
1169
+ * * `backup_schedules:daily`
1170
+ * - The backup is created from a schedule with "daily" in its name.
1171
+ * @param {number} request.pageSize
1172
+ * Number of backups to be returned in the response. If 0 or
1173
+ * less, defaults to the server's maximum allowed page size.
1174
+ * @param {string} request.pageToken
1175
+ * If non-empty, `page_token` should contain a
1176
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse.next_page_token|next_page_token}
1177
+ * from a previous
1178
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse|ListBackupsResponse}
1179
+ * to the same `parent` and with the same `filter`.
1180
+ * @param {object} [options]
1181
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1182
+ * @returns {Promise} - The promise which resolves to an array.
1183
+ * The first element of the array is Array of {@link protos.google.spanner.admin.database.v1.Backup|Backup}.
1184
+ * The client library will perform auto-pagination by default: it will call the API as many
1185
+ * times as needed and will merge results from all the pages into this array.
1186
+ * Note that it can affect your quota.
1187
+ * We recommend using `listBackupsAsync()`
1188
+ * method described below for async iteration which you can stop as needed.
1189
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1190
+ * for more details and examples.
1191
+ */
1192
+ listBackups(request?: protos.google.spanner.admin.database.v1.IListBackupsRequest, options?: CallOptions): Promise<[
1193
+ protos.google.spanner.admin.database.v1.IBackup[],
1194
+ protos.google.spanner.admin.database.v1.IListBackupsRequest | null,
1195
+ protos.google.spanner.admin.database.v1.IListBackupsResponse
1196
+ ]>;
1197
+ listBackups(request: protos.google.spanner.admin.database.v1.IListBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupsRequest, protos.google.spanner.admin.database.v1.IListBackupsResponse | null | undefined, protos.google.spanner.admin.database.v1.IBackup>): void;
1198
+ listBackups(request: protos.google.spanner.admin.database.v1.IListBackupsRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupsRequest, protos.google.spanner.admin.database.v1.IListBackupsResponse | null | undefined, protos.google.spanner.admin.database.v1.IBackup>): void;
1199
+ /**
1200
+ * Equivalent to `listBackups`, but returns a NodeJS Stream object.
1201
+ * @param {Object} request
1202
+ * The request object that will be sent.
1203
+ * @param {string} request.parent
1204
+ * Required. The instance to list backups from. Values are of the
1205
+ * form `projects/<project>/instances/<instance>`.
1206
+ * @param {string} request.filter
1207
+ * An expression that filters the list of returned backups.
1208
+ *
1209
+ * A filter expression consists of a field name, a comparison operator, and a
1210
+ * value for filtering.
1211
+ * The value must be a string, a number, or a boolean. The comparison operator
1212
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1213
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1214
+ *
1215
+ * The following fields in the
1216
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup} are eligible for
1217
+ * filtering:
1218
+ *
1219
+ * * `name`
1220
+ * * `database`
1221
+ * * `state`
1222
+ * * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1223
+ * * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1224
+ * * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1225
+ * * `size_bytes`
1226
+ * * `backup_schedules`
1227
+ *
1228
+ * You can combine multiple expressions by enclosing each expression in
1229
+ * parentheses. By default, expressions are combined with AND logic, but
1230
+ * you can specify AND, OR, and NOT logic explicitly.
1231
+ *
1232
+ * Here are a few examples:
1233
+ *
1234
+ * * `name:Howl` - The backup's name contains the string "howl".
1235
+ * * `database:prod`
1236
+ * - The database's name contains the string "prod".
1237
+ * * `state:CREATING` - The backup is pending creation.
1238
+ * * `state:READY` - The backup is fully created and ready for use.
1239
+ * * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
1240
+ * - The backup name contains the string "howl" and `create_time`
1241
+ * of the backup is before 2018-03-28T14:50:00Z.
1242
+ * * `expire_time < \"2018-03-28T14:50:00Z\"`
1243
+ * - The backup `expire_time` is before 2018-03-28T14:50:00Z.
1244
+ * * `size_bytes > 10000000000` - The backup's size is greater than 10GB
1245
+ * * `backup_schedules:daily`
1246
+ * - The backup is created from a schedule with "daily" in its name.
1247
+ * @param {number} request.pageSize
1248
+ * Number of backups to be returned in the response. If 0 or
1249
+ * less, defaults to the server's maximum allowed page size.
1250
+ * @param {string} request.pageToken
1251
+ * If non-empty, `page_token` should contain a
1252
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse.next_page_token|next_page_token}
1253
+ * from a previous
1254
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse|ListBackupsResponse}
1255
+ * to the same `parent` and with the same `filter`.
1256
+ * @param {object} [options]
1257
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1258
+ * @returns {Stream}
1259
+ * An object stream which emits an object representing {@link protos.google.spanner.admin.database.v1.Backup|Backup} on 'data' event.
1260
+ * The client library will perform auto-pagination by default: it will call the API as many
1261
+ * times as needed. Note that it can affect your quota.
1262
+ * We recommend using `listBackupsAsync()`
1263
+ * method described below for async iteration which you can stop as needed.
1264
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1265
+ * for more details and examples.
1266
+ */
1267
+ listBackupsStream(request?: protos.google.spanner.admin.database.v1.IListBackupsRequest, options?: CallOptions): Transform;
1268
+ /**
1269
+ * Equivalent to `listBackups`, but returns an iterable object.
1270
+ *
1271
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1272
+ * @param {Object} request
1273
+ * The request object that will be sent.
1274
+ * @param {string} request.parent
1275
+ * Required. The instance to list backups from. Values are of the
1276
+ * form `projects/<project>/instances/<instance>`.
1277
+ * @param {string} request.filter
1278
+ * An expression that filters the list of returned backups.
1279
+ *
1280
+ * A filter expression consists of a field name, a comparison operator, and a
1281
+ * value for filtering.
1282
+ * The value must be a string, a number, or a boolean. The comparison operator
1283
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1284
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1285
+ *
1286
+ * The following fields in the
1287
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup} are eligible for
1288
+ * filtering:
1289
+ *
1290
+ * * `name`
1291
+ * * `database`
1292
+ * * `state`
1293
+ * * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1294
+ * * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1295
+ * * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1296
+ * * `size_bytes`
1297
+ * * `backup_schedules`
1298
+ *
1299
+ * You can combine multiple expressions by enclosing each expression in
1300
+ * parentheses. By default, expressions are combined with AND logic, but
1301
+ * you can specify AND, OR, and NOT logic explicitly.
1302
+ *
1303
+ * Here are a few examples:
1304
+ *
1305
+ * * `name:Howl` - The backup's name contains the string "howl".
1306
+ * * `database:prod`
1307
+ * - The database's name contains the string "prod".
1308
+ * * `state:CREATING` - The backup is pending creation.
1309
+ * * `state:READY` - The backup is fully created and ready for use.
1310
+ * * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
1311
+ * - The backup name contains the string "howl" and `create_time`
1312
+ * of the backup is before 2018-03-28T14:50:00Z.
1313
+ * * `expire_time < \"2018-03-28T14:50:00Z\"`
1314
+ * - The backup `expire_time` is before 2018-03-28T14:50:00Z.
1315
+ * * `size_bytes > 10000000000` - The backup's size is greater than 10GB
1316
+ * * `backup_schedules:daily`
1317
+ * - The backup is created from a schedule with "daily" in its name.
1318
+ * @param {number} request.pageSize
1319
+ * Number of backups to be returned in the response. If 0 or
1320
+ * less, defaults to the server's maximum allowed page size.
1321
+ * @param {string} request.pageToken
1322
+ * If non-empty, `page_token` should contain a
1323
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse.next_page_token|next_page_token}
1324
+ * from a previous
1325
+ * {@link protos.google.spanner.admin.database.v1.ListBackupsResponse|ListBackupsResponse}
1326
+ * to the same `parent` and with the same `filter`.
1327
+ * @param {object} [options]
1328
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1329
+ * @returns {Object}
1330
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1331
+ * When you iterate the returned iterable, each element will be an object representing
1332
+ * {@link protos.google.spanner.admin.database.v1.Backup|Backup}. The API will be called under the hood as needed, once per the page,
1333
+ * so you can stop the iteration when you don't need more results.
1334
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1335
+ * for more details and examples.
1336
+ * @example <caption>include:samples/generated/v1/database_admin.list_backups.js</caption>
1337
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListBackups_async
1338
+ */
1339
+ listBackupsAsync(request?: protos.google.spanner.admin.database.v1.IListBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.spanner.admin.database.v1.IBackup>;
1340
+ /**
1341
+ * Lists database {@link protos.google.longrunning.Operation|longrunning-operations}.
1342
+ * A database operation has a name of the form
1343
+ * `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
1344
+ * The long-running operation
1345
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type
1346
+ * `metadata.type_url` describes the type of the metadata. Operations returned
1347
+ * include those that have completed/failed/canceled within the last 7 days,
1348
+ * and pending operations.
1349
+ *
1350
+ * @param {Object} request
1351
+ * The request object that will be sent.
1352
+ * @param {string} request.parent
1353
+ * Required. The instance of the database operations.
1354
+ * Values are of the form `projects/<project>/instances/<instance>`.
1355
+ * @param {string} request.filter
1356
+ * An expression that filters the list of returned operations.
1357
+ *
1358
+ * A filter expression consists of a field name, a
1359
+ * comparison operator, and a value for filtering.
1360
+ * The value must be a string, a number, or a boolean. The comparison operator
1361
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1362
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1363
+ *
1364
+ * The following fields in the {@link protos.google.longrunning.Operation|Operation}
1365
+ * are eligible for filtering:
1366
+ *
1367
+ * * `name` - The name of the long-running operation
1368
+ * * `done` - False if the operation is in progress, else true.
1369
+ * * `metadata.@type` - the type of metadata. For example, the type string
1370
+ * for
1371
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}
1372
+ * is
1373
+ * `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
1374
+ * * `metadata.<field_name>` - any field in metadata.value.
1375
+ * `metadata.@type` must be specified first, if filtering on metadata
1376
+ * fields.
1377
+ * * `error` - Error associated with the long-running operation.
1378
+ * * `response.@type` - the type of response.
1379
+ * * `response.<field_name>` - any field in response.value.
1380
+ *
1381
+ * You can combine multiple expressions by enclosing each expression in
1382
+ * parentheses. By default, expressions are combined with AND logic. However,
1383
+ * you can specify AND, OR, and NOT logic explicitly.
1384
+ *
1385
+ * Here are a few examples:
1386
+ *
1387
+ * * `done:true` - The operation is complete.
1388
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
1389
+ * `(metadata.source_type:BACKUP) AND` \
1390
+ * `(metadata.backup_info.backup:backup_howl) AND` \
1391
+ * `(metadata.name:restored_howl) AND` \
1392
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1393
+ * `(error:*)` - Return operations where:
1394
+ * * The operation's metadata type is
1395
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}.
1396
+ * * The database is restored from a backup.
1397
+ * * The backup name contains "backup_howl".
1398
+ * * The restored database's name contains "restored_howl".
1399
+ * * The operation started before 2018-03-28T14:50:00Z.
1400
+ * * The operation resulted in an error.
1401
+ * @param {number} request.pageSize
1402
+ * Number of operations to be returned in the response. If 0 or
1403
+ * less, defaults to the server's maximum allowed page size.
1404
+ * @param {string} request.pageToken
1405
+ * If non-empty, `page_token` should contain a
1406
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token|next_page_token}
1407
+ * from a previous
1408
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse|ListDatabaseOperationsResponse}
1409
+ * to the same `parent` and with the same `filter`.
1410
+ * @param {object} [options]
1411
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1412
+ * @returns {Promise} - The promise which resolves to an array.
1413
+ * The first element of the array is Array of {@link protos.google.longrunning.Operation|Operation}.
1414
+ * The client library will perform auto-pagination by default: it will call the API as many
1415
+ * times as needed and will merge results from all the pages into this array.
1416
+ * Note that it can affect your quota.
1417
+ * We recommend using `listDatabaseOperationsAsync()`
1418
+ * method described below for async iteration which you can stop as needed.
1419
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1420
+ * for more details and examples.
1421
+ */
1422
+ listDatabaseOperations(request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, options?: CallOptions): Promise<[
1423
+ protos.google.longrunning.IOperation[],
1424
+ protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest | null,
1425
+ protos.google.spanner.admin.database.v1.IListDatabaseOperationsResponse
1426
+ ]>;
1427
+ listDatabaseOperations(request: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, protos.google.spanner.admin.database.v1.IListDatabaseOperationsResponse | null | undefined, protos.google.longrunning.IOperation>): void;
1428
+ listDatabaseOperations(request: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, protos.google.spanner.admin.database.v1.IListDatabaseOperationsResponse | null | undefined, protos.google.longrunning.IOperation>): void;
1429
+ /**
1430
+ * Equivalent to `listDatabaseOperations`, but returns a NodeJS Stream object.
1431
+ * @param {Object} request
1432
+ * The request object that will be sent.
1433
+ * @param {string} request.parent
1434
+ * Required. The instance of the database operations.
1435
+ * Values are of the form `projects/<project>/instances/<instance>`.
1436
+ * @param {string} request.filter
1437
+ * An expression that filters the list of returned operations.
1438
+ *
1439
+ * A filter expression consists of a field name, a
1440
+ * comparison operator, and a value for filtering.
1441
+ * The value must be a string, a number, or a boolean. The comparison operator
1442
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1443
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1444
+ *
1445
+ * The following fields in the {@link protos.google.longrunning.Operation|Operation}
1446
+ * are eligible for filtering:
1447
+ *
1448
+ * * `name` - The name of the long-running operation
1449
+ * * `done` - False if the operation is in progress, else true.
1450
+ * * `metadata.@type` - the type of metadata. For example, the type string
1451
+ * for
1452
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}
1453
+ * is
1454
+ * `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
1455
+ * * `metadata.<field_name>` - any field in metadata.value.
1456
+ * `metadata.@type` must be specified first, if filtering on metadata
1457
+ * fields.
1458
+ * * `error` - Error associated with the long-running operation.
1459
+ * * `response.@type` - the type of response.
1460
+ * * `response.<field_name>` - any field in response.value.
1461
+ *
1462
+ * You can combine multiple expressions by enclosing each expression in
1463
+ * parentheses. By default, expressions are combined with AND logic. However,
1464
+ * you can specify AND, OR, and NOT logic explicitly.
1465
+ *
1466
+ * Here are a few examples:
1467
+ *
1468
+ * * `done:true` - The operation is complete.
1469
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
1470
+ * `(metadata.source_type:BACKUP) AND` \
1471
+ * `(metadata.backup_info.backup:backup_howl) AND` \
1472
+ * `(metadata.name:restored_howl) AND` \
1473
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1474
+ * `(error:*)` - Return operations where:
1475
+ * * The operation's metadata type is
1476
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}.
1477
+ * * The database is restored from a backup.
1478
+ * * The backup name contains "backup_howl".
1479
+ * * The restored database's name contains "restored_howl".
1480
+ * * The operation started before 2018-03-28T14:50:00Z.
1481
+ * * The operation resulted in an error.
1482
+ * @param {number} request.pageSize
1483
+ * Number of operations to be returned in the response. If 0 or
1484
+ * less, defaults to the server's maximum allowed page size.
1485
+ * @param {string} request.pageToken
1486
+ * If non-empty, `page_token` should contain a
1487
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token|next_page_token}
1488
+ * from a previous
1489
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse|ListDatabaseOperationsResponse}
1490
+ * to the same `parent` and with the same `filter`.
1491
+ * @param {object} [options]
1492
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1493
+ * @returns {Stream}
1494
+ * An object stream which emits an object representing {@link protos.google.longrunning.Operation|Operation} on 'data' event.
1495
+ * The client library will perform auto-pagination by default: it will call the API as many
1496
+ * times as needed. Note that it can affect your quota.
1497
+ * We recommend using `listDatabaseOperationsAsync()`
1498
+ * method described below for async iteration which you can stop as needed.
1499
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1500
+ * for more details and examples.
1501
+ */
1502
+ listDatabaseOperationsStream(request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, options?: CallOptions): Transform;
1503
+ /**
1504
+ * Equivalent to `listDatabaseOperations`, but returns an iterable object.
1505
+ *
1506
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1507
+ * @param {Object} request
1508
+ * The request object that will be sent.
1509
+ * @param {string} request.parent
1510
+ * Required. The instance of the database operations.
1511
+ * Values are of the form `projects/<project>/instances/<instance>`.
1512
+ * @param {string} request.filter
1513
+ * An expression that filters the list of returned operations.
1514
+ *
1515
+ * A filter expression consists of a field name, a
1516
+ * comparison operator, and a value for filtering.
1517
+ * The value must be a string, a number, or a boolean. The comparison operator
1518
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1519
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1520
+ *
1521
+ * The following fields in the {@link protos.google.longrunning.Operation|Operation}
1522
+ * are eligible for filtering:
1523
+ *
1524
+ * * `name` - The name of the long-running operation
1525
+ * * `done` - False if the operation is in progress, else true.
1526
+ * * `metadata.@type` - the type of metadata. For example, the type string
1527
+ * for
1528
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}
1529
+ * is
1530
+ * `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
1531
+ * * `metadata.<field_name>` - any field in metadata.value.
1532
+ * `metadata.@type` must be specified first, if filtering on metadata
1533
+ * fields.
1534
+ * * `error` - Error associated with the long-running operation.
1535
+ * * `response.@type` - the type of response.
1536
+ * * `response.<field_name>` - any field in response.value.
1537
+ *
1538
+ * You can combine multiple expressions by enclosing each expression in
1539
+ * parentheses. By default, expressions are combined with AND logic. However,
1540
+ * you can specify AND, OR, and NOT logic explicitly.
1541
+ *
1542
+ * Here are a few examples:
1543
+ *
1544
+ * * `done:true` - The operation is complete.
1545
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
1546
+ * `(metadata.source_type:BACKUP) AND` \
1547
+ * `(metadata.backup_info.backup:backup_howl) AND` \
1548
+ * `(metadata.name:restored_howl) AND` \
1549
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1550
+ * `(error:*)` - Return operations where:
1551
+ * * The operation's metadata type is
1552
+ * {@link protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata|RestoreDatabaseMetadata}.
1553
+ * * The database is restored from a backup.
1554
+ * * The backup name contains "backup_howl".
1555
+ * * The restored database's name contains "restored_howl".
1556
+ * * The operation started before 2018-03-28T14:50:00Z.
1557
+ * * The operation resulted in an error.
1558
+ * @param {number} request.pageSize
1559
+ * Number of operations to be returned in the response. If 0 or
1560
+ * less, defaults to the server's maximum allowed page size.
1561
+ * @param {string} request.pageToken
1562
+ * If non-empty, `page_token` should contain a
1563
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token|next_page_token}
1564
+ * from a previous
1565
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse|ListDatabaseOperationsResponse}
1566
+ * to the same `parent` and with the same `filter`.
1567
+ * @param {object} [options]
1568
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1569
+ * @returns {Object}
1570
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1571
+ * When you iterate the returned iterable, each element will be an object representing
1572
+ * {@link protos.google.longrunning.Operation|Operation}. The API will be called under the hood as needed, once per the page,
1573
+ * so you can stop the iteration when you don't need more results.
1574
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1575
+ * for more details and examples.
1576
+ * @example <caption>include:samples/generated/v1/database_admin.list_database_operations.js</caption>
1577
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListDatabaseOperations_async
1578
+ */
1579
+ listDatabaseOperationsAsync(request?: protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest, options?: CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
1580
+ /**
1581
+ * Lists the backup {@link protos.google.longrunning.Operation|long-running operations} in
1582
+ * the given instance. A backup operation has a name of the form
1583
+ * `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.
1584
+ * The long-running operation
1585
+ * {@link protos.google.longrunning.Operation.metadata|metadata} field type
1586
+ * `metadata.type_url` describes the type of the metadata. Operations returned
1587
+ * include those that have completed/failed/canceled within the last 7 days,
1588
+ * and pending operations. Operations returned are ordered by
1589
+ * `operation.metadata.value.progress.start_time` in descending order starting
1590
+ * from the most recently started operation.
1591
+ *
1592
+ * @param {Object} request
1593
+ * The request object that will be sent.
1594
+ * @param {string} request.parent
1595
+ * Required. The instance of the backup operations. Values are of
1596
+ * the form `projects/<project>/instances/<instance>`.
1597
+ * @param {string} request.filter
1598
+ * An expression that filters the list of returned backup operations.
1599
+ *
1600
+ * A filter expression consists of a field name, a
1601
+ * comparison operator, and a value for filtering.
1602
+ * The value must be a string, a number, or a boolean. The comparison operator
1603
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1604
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1605
+ *
1606
+ * The following fields in the {@link protos.google.longrunning.Operation|operation}
1607
+ * are eligible for filtering:
1608
+ *
1609
+ * * `name` - The name of the long-running operation
1610
+ * * `done` - False if the operation is in progress, else true.
1611
+ * * `metadata.@type` - the type of metadata. For example, the type string
1612
+ * for
1613
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1614
+ * is
1615
+ * `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
1616
+ * * `metadata.<field_name>` - any field in metadata.value.
1617
+ * `metadata.@type` must be specified first if filtering on metadata
1618
+ * fields.
1619
+ * * `error` - Error associated with the long-running operation.
1620
+ * * `response.@type` - the type of response.
1621
+ * * `response.<field_name>` - any field in response.value.
1622
+ *
1623
+ * You can combine multiple expressions by enclosing each expression in
1624
+ * parentheses. By default, expressions are combined with AND logic, but
1625
+ * you can specify AND, OR, and NOT logic explicitly.
1626
+ *
1627
+ * Here are a few examples:
1628
+ *
1629
+ * * `done:true` - The operation is complete.
1630
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1631
+ * `metadata.database:prod` - Returns operations where:
1632
+ * * The operation's metadata type is
1633
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1634
+ * * The source database name of backup contains the string "prod".
1635
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1636
+ * `(metadata.name:howl) AND` \
1637
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1638
+ * `(error:*)` - Returns operations where:
1639
+ * * The operation's metadata type is
1640
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1641
+ * * The backup name contains the string "howl".
1642
+ * * The operation started before 2018-03-28T14:50:00Z.
1643
+ * * The operation resulted in an error.
1644
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
1645
+ * `(metadata.source_backup:test) AND` \
1646
+ * `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
1647
+ * `(error:*)` - Returns operations where:
1648
+ * * The operation's metadata type is
1649
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}.
1650
+ * * The source backup name contains the string "test".
1651
+ * * The operation started before 2022-01-18T14:50:00Z.
1652
+ * * The operation resulted in an error.
1653
+ * * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1654
+ * `(metadata.database:test_db)) OR` \
1655
+ * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
1656
+ * AND` \
1657
+ * `(metadata.source_backup:test_bkp)) AND` \
1658
+ * `(error:*)` - Returns operations where:
1659
+ * * The operation's metadata matches either of criteria:
1660
+ * * The operation's metadata type is
1661
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1662
+ * AND the source database name of the backup contains the string
1663
+ * "test_db"
1664
+ * * The operation's metadata type is
1665
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}
1666
+ * AND the source backup name contains the string "test_bkp"
1667
+ * * The operation resulted in an error.
1668
+ * @param {number} request.pageSize
1669
+ * Number of operations to be returned in the response. If 0 or
1670
+ * less, defaults to the server's maximum allowed page size.
1671
+ * @param {string} request.pageToken
1672
+ * If non-empty, `page_token` should contain a
1673
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token|next_page_token}
1674
+ * from a previous
1675
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse|ListBackupOperationsResponse}
1676
+ * to the same `parent` and with the same `filter`.
1677
+ * @param {object} [options]
1678
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1679
+ * @returns {Promise} - The promise which resolves to an array.
1680
+ * The first element of the array is Array of {@link protos.google.longrunning.Operation|Operation}.
1681
+ * The client library will perform auto-pagination by default: it will call the API as many
1682
+ * times as needed and will merge results from all the pages into this array.
1683
+ * Note that it can affect your quota.
1684
+ * We recommend using `listBackupOperationsAsync()`
1685
+ * method described below for async iteration which you can stop as needed.
1686
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1687
+ * for more details and examples.
1688
+ */
1689
+ listBackupOperations(request?: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, options?: CallOptions): Promise<[
1690
+ protos.google.longrunning.IOperation[],
1691
+ protos.google.spanner.admin.database.v1.IListBackupOperationsRequest | null,
1692
+ protos.google.spanner.admin.database.v1.IListBackupOperationsResponse
1693
+ ]>;
1694
+ listBackupOperations(request: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, protos.google.spanner.admin.database.v1.IListBackupOperationsResponse | null | undefined, protos.google.longrunning.IOperation>): void;
1695
+ listBackupOperations(request: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, protos.google.spanner.admin.database.v1.IListBackupOperationsResponse | null | undefined, protos.google.longrunning.IOperation>): void;
1696
+ /**
1697
+ * Equivalent to `listBackupOperations`, but returns a NodeJS Stream object.
1698
+ * @param {Object} request
1699
+ * The request object that will be sent.
1700
+ * @param {string} request.parent
1701
+ * Required. The instance of the backup operations. Values are of
1702
+ * the form `projects/<project>/instances/<instance>`.
1703
+ * @param {string} request.filter
1704
+ * An expression that filters the list of returned backup operations.
1705
+ *
1706
+ * A filter expression consists of a field name, a
1707
+ * comparison operator, and a value for filtering.
1708
+ * The value must be a string, a number, or a boolean. The comparison operator
1709
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1710
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1711
+ *
1712
+ * The following fields in the {@link protos.google.longrunning.Operation|operation}
1713
+ * are eligible for filtering:
1714
+ *
1715
+ * * `name` - The name of the long-running operation
1716
+ * * `done` - False if the operation is in progress, else true.
1717
+ * * `metadata.@type` - the type of metadata. For example, the type string
1718
+ * for
1719
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1720
+ * is
1721
+ * `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
1722
+ * * `metadata.<field_name>` - any field in metadata.value.
1723
+ * `metadata.@type` must be specified first if filtering on metadata
1724
+ * fields.
1725
+ * * `error` - Error associated with the long-running operation.
1726
+ * * `response.@type` - the type of response.
1727
+ * * `response.<field_name>` - any field in response.value.
1728
+ *
1729
+ * You can combine multiple expressions by enclosing each expression in
1730
+ * parentheses. By default, expressions are combined with AND logic, but
1731
+ * you can specify AND, OR, and NOT logic explicitly.
1732
+ *
1733
+ * Here are a few examples:
1734
+ *
1735
+ * * `done:true` - The operation is complete.
1736
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1737
+ * `metadata.database:prod` - Returns operations where:
1738
+ * * The operation's metadata type is
1739
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1740
+ * * The source database name of backup contains the string "prod".
1741
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1742
+ * `(metadata.name:howl) AND` \
1743
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1744
+ * `(error:*)` - Returns operations where:
1745
+ * * The operation's metadata type is
1746
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1747
+ * * The backup name contains the string "howl".
1748
+ * * The operation started before 2018-03-28T14:50:00Z.
1749
+ * * The operation resulted in an error.
1750
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
1751
+ * `(metadata.source_backup:test) AND` \
1752
+ * `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
1753
+ * `(error:*)` - Returns operations where:
1754
+ * * The operation's metadata type is
1755
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}.
1756
+ * * The source backup name contains the string "test".
1757
+ * * The operation started before 2022-01-18T14:50:00Z.
1758
+ * * The operation resulted in an error.
1759
+ * * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1760
+ * `(metadata.database:test_db)) OR` \
1761
+ * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
1762
+ * AND` \
1763
+ * `(metadata.source_backup:test_bkp)) AND` \
1764
+ * `(error:*)` - Returns operations where:
1765
+ * * The operation's metadata matches either of criteria:
1766
+ * * The operation's metadata type is
1767
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1768
+ * AND the source database name of the backup contains the string
1769
+ * "test_db"
1770
+ * * The operation's metadata type is
1771
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}
1772
+ * AND the source backup name contains the string "test_bkp"
1773
+ * * The operation resulted in an error.
1774
+ * @param {number} request.pageSize
1775
+ * Number of operations to be returned in the response. If 0 or
1776
+ * less, defaults to the server's maximum allowed page size.
1777
+ * @param {string} request.pageToken
1778
+ * If non-empty, `page_token` should contain a
1779
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token|next_page_token}
1780
+ * from a previous
1781
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse|ListBackupOperationsResponse}
1782
+ * to the same `parent` and with the same `filter`.
1783
+ * @param {object} [options]
1784
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1785
+ * @returns {Stream}
1786
+ * An object stream which emits an object representing {@link protos.google.longrunning.Operation|Operation} on 'data' event.
1787
+ * The client library will perform auto-pagination by default: it will call the API as many
1788
+ * times as needed. Note that it can affect your quota.
1789
+ * We recommend using `listBackupOperationsAsync()`
1790
+ * method described below for async iteration which you can stop as needed.
1791
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1792
+ * for more details and examples.
1793
+ */
1794
+ listBackupOperationsStream(request?: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, options?: CallOptions): Transform;
1795
+ /**
1796
+ * Equivalent to `listBackupOperations`, but returns an iterable object.
1797
+ *
1798
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1799
+ * @param {Object} request
1800
+ * The request object that will be sent.
1801
+ * @param {string} request.parent
1802
+ * Required. The instance of the backup operations. Values are of
1803
+ * the form `projects/<project>/instances/<instance>`.
1804
+ * @param {string} request.filter
1805
+ * An expression that filters the list of returned backup operations.
1806
+ *
1807
+ * A filter expression consists of a field name, a
1808
+ * comparison operator, and a value for filtering.
1809
+ * The value must be a string, a number, or a boolean. The comparison operator
1810
+ * must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1811
+ * Colon `:` is the contains operator. Filter rules are not case sensitive.
1812
+ *
1813
+ * The following fields in the {@link protos.google.longrunning.Operation|operation}
1814
+ * are eligible for filtering:
1815
+ *
1816
+ * * `name` - The name of the long-running operation
1817
+ * * `done` - False if the operation is in progress, else true.
1818
+ * * `metadata.@type` - the type of metadata. For example, the type string
1819
+ * for
1820
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1821
+ * is
1822
+ * `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
1823
+ * * `metadata.<field_name>` - any field in metadata.value.
1824
+ * `metadata.@type` must be specified first if filtering on metadata
1825
+ * fields.
1826
+ * * `error` - Error associated with the long-running operation.
1827
+ * * `response.@type` - the type of response.
1828
+ * * `response.<field_name>` - any field in response.value.
1829
+ *
1830
+ * You can combine multiple expressions by enclosing each expression in
1831
+ * parentheses. By default, expressions are combined with AND logic, but
1832
+ * you can specify AND, OR, and NOT logic explicitly.
1833
+ *
1834
+ * Here are a few examples:
1835
+ *
1836
+ * * `done:true` - The operation is complete.
1837
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1838
+ * `metadata.database:prod` - Returns operations where:
1839
+ * * The operation's metadata type is
1840
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1841
+ * * The source database name of backup contains the string "prod".
1842
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1843
+ * `(metadata.name:howl) AND` \
1844
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1845
+ * `(error:*)` - Returns operations where:
1846
+ * * The operation's metadata type is
1847
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}.
1848
+ * * The backup name contains the string "howl".
1849
+ * * The operation started before 2018-03-28T14:50:00Z.
1850
+ * * The operation resulted in an error.
1851
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
1852
+ * `(metadata.source_backup:test) AND` \
1853
+ * `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
1854
+ * `(error:*)` - Returns operations where:
1855
+ * * The operation's metadata type is
1856
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}.
1857
+ * * The source backup name contains the string "test".
1858
+ * * The operation started before 2022-01-18T14:50:00Z.
1859
+ * * The operation resulted in an error.
1860
+ * * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
1861
+ * `(metadata.database:test_db)) OR` \
1862
+ * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
1863
+ * AND` \
1864
+ * `(metadata.source_backup:test_bkp)) AND` \
1865
+ * `(error:*)` - Returns operations where:
1866
+ * * The operation's metadata matches either of criteria:
1867
+ * * The operation's metadata type is
1868
+ * {@link protos.google.spanner.admin.database.v1.CreateBackupMetadata|CreateBackupMetadata}
1869
+ * AND the source database name of the backup contains the string
1870
+ * "test_db"
1871
+ * * The operation's metadata type is
1872
+ * {@link protos.google.spanner.admin.database.v1.CopyBackupMetadata|CopyBackupMetadata}
1873
+ * AND the source backup name contains the string "test_bkp"
1874
+ * * The operation resulted in an error.
1875
+ * @param {number} request.pageSize
1876
+ * Number of operations to be returned in the response. If 0 or
1877
+ * less, defaults to the server's maximum allowed page size.
1878
+ * @param {string} request.pageToken
1879
+ * If non-empty, `page_token` should contain a
1880
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token|next_page_token}
1881
+ * from a previous
1882
+ * {@link protos.google.spanner.admin.database.v1.ListBackupOperationsResponse|ListBackupOperationsResponse}
1883
+ * to the same `parent` and with the same `filter`.
1884
+ * @param {object} [options]
1885
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1886
+ * @returns {Object}
1887
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1888
+ * When you iterate the returned iterable, each element will be an object representing
1889
+ * {@link protos.google.longrunning.Operation|Operation}. The API will be called under the hood as needed, once per the page,
1890
+ * so you can stop the iteration when you don't need more results.
1891
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1892
+ * for more details and examples.
1893
+ * @example <caption>include:samples/generated/v1/database_admin.list_backup_operations.js</caption>
1894
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListBackupOperations_async
1895
+ */
1896
+ listBackupOperationsAsync(request?: protos.google.spanner.admin.database.v1.IListBackupOperationsRequest, options?: CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
1897
+ /**
1898
+ * Lists Cloud Spanner database roles.
1899
+ *
1900
+ * @param {Object} request
1901
+ * The request object that will be sent.
1902
+ * @param {string} request.parent
1903
+ * Required. The database whose roles should be listed.
1904
+ * Values are of the form
1905
+ * `projects/<project>/instances/<instance>/databases/<database>`.
1906
+ * @param {number} request.pageSize
1907
+ * Number of database roles to be returned in the response. If 0 or less,
1908
+ * defaults to the server's maximum allowed page size.
1909
+ * @param {string} request.pageToken
1910
+ * If non-empty, `page_token` should contain a
1911
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token|next_page_token}
1912
+ * from a previous
1913
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse|ListDatabaseRolesResponse}.
1914
+ * @param {object} [options]
1915
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1916
+ * @returns {Promise} - The promise which resolves to an array.
1917
+ * The first element of the array is Array of {@link protos.google.spanner.admin.database.v1.DatabaseRole|DatabaseRole}.
1918
+ * The client library will perform auto-pagination by default: it will call the API as many
1919
+ * times as needed and will merge results from all the pages into this array.
1920
+ * Note that it can affect your quota.
1921
+ * We recommend using `listDatabaseRolesAsync()`
1922
+ * method described below for async iteration which you can stop as needed.
1923
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1924
+ * for more details and examples.
1925
+ */
1926
+ listDatabaseRoles(request?: protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, options?: CallOptions): Promise<[
1927
+ protos.google.spanner.admin.database.v1.IDatabaseRole[],
1928
+ protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest | null,
1929
+ protos.google.spanner.admin.database.v1.IListDatabaseRolesResponse
1930
+ ]>;
1931
+ listDatabaseRoles(request: protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, protos.google.spanner.admin.database.v1.IListDatabaseRolesResponse | null | undefined, protos.google.spanner.admin.database.v1.IDatabaseRole>): void;
1932
+ listDatabaseRoles(request: protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, protos.google.spanner.admin.database.v1.IListDatabaseRolesResponse | null | undefined, protos.google.spanner.admin.database.v1.IDatabaseRole>): void;
1933
+ /**
1934
+ * Equivalent to `listDatabaseRoles`, but returns a NodeJS Stream object.
1935
+ * @param {Object} request
1936
+ * The request object that will be sent.
1937
+ * @param {string} request.parent
1938
+ * Required. The database whose roles should be listed.
1939
+ * Values are of the form
1940
+ * `projects/<project>/instances/<instance>/databases/<database>`.
1941
+ * @param {number} request.pageSize
1942
+ * Number of database roles to be returned in the response. If 0 or less,
1943
+ * defaults to the server's maximum allowed page size.
1944
+ * @param {string} request.pageToken
1945
+ * If non-empty, `page_token` should contain a
1946
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token|next_page_token}
1947
+ * from a previous
1948
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse|ListDatabaseRolesResponse}.
1949
+ * @param {object} [options]
1950
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1951
+ * @returns {Stream}
1952
+ * An object stream which emits an object representing {@link protos.google.spanner.admin.database.v1.DatabaseRole|DatabaseRole} on 'data' event.
1953
+ * The client library will perform auto-pagination by default: it will call the API as many
1954
+ * times as needed. Note that it can affect your quota.
1955
+ * We recommend using `listDatabaseRolesAsync()`
1956
+ * method described below for async iteration which you can stop as needed.
1957
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1958
+ * for more details and examples.
1959
+ */
1960
+ listDatabaseRolesStream(request?: protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, options?: CallOptions): Transform;
1961
+ /**
1962
+ * Equivalent to `listDatabaseRoles`, but returns an iterable object.
1963
+ *
1964
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1965
+ * @param {Object} request
1966
+ * The request object that will be sent.
1967
+ * @param {string} request.parent
1968
+ * Required. The database whose roles should be listed.
1969
+ * Values are of the form
1970
+ * `projects/<project>/instances/<instance>/databases/<database>`.
1971
+ * @param {number} request.pageSize
1972
+ * Number of database roles to be returned in the response. If 0 or less,
1973
+ * defaults to the server's maximum allowed page size.
1974
+ * @param {string} request.pageToken
1975
+ * If non-empty, `page_token` should contain a
1976
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse.next_page_token|next_page_token}
1977
+ * from a previous
1978
+ * {@link protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse|ListDatabaseRolesResponse}.
1979
+ * @param {object} [options]
1980
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1981
+ * @returns {Object}
1982
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1983
+ * When you iterate the returned iterable, each element will be an object representing
1984
+ * {@link protos.google.spanner.admin.database.v1.DatabaseRole|DatabaseRole}. The API will be called under the hood as needed, once per the page,
1985
+ * so you can stop the iteration when you don't need more results.
1986
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1987
+ * for more details and examples.
1988
+ * @example <caption>include:samples/generated/v1/database_admin.list_database_roles.js</caption>
1989
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListDatabaseRoles_async
1990
+ */
1991
+ listDatabaseRolesAsync(request?: protos.google.spanner.admin.database.v1.IListDatabaseRolesRequest, options?: CallOptions): AsyncIterable<protos.google.spanner.admin.database.v1.IDatabaseRole>;
1992
+ /**
1993
+ * Lists all the backup schedules for the database.
1994
+ *
1995
+ * @param {Object} request
1996
+ * The request object that will be sent.
1997
+ * @param {string} request.parent
1998
+ * Required. Database is the parent resource whose backup schedules should be
1999
+ * listed. Values are of the form
2000
+ * projects/<project>/instances/<instance>/databases/<database>
2001
+ * @param {number} [request.pageSize]
2002
+ * Optional. Number of backup schedules to be returned in the response. If 0
2003
+ * or less, defaults to the server's maximum allowed page size.
2004
+ * @param {string} [request.pageToken]
2005
+ * Optional. If non-empty, `page_token` should contain a
2006
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse.next_page_token|next_page_token}
2007
+ * from a previous
2008
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse|ListBackupSchedulesResponse}
2009
+ * to the same `parent`.
2010
+ * @param {object} [options]
2011
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2012
+ * @returns {Promise} - The promise which resolves to an array.
2013
+ * The first element of the array is Array of {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule}.
2014
+ * The client library will perform auto-pagination by default: it will call the API as many
2015
+ * times as needed and will merge results from all the pages into this array.
2016
+ * Note that it can affect your quota.
2017
+ * We recommend using `listBackupSchedulesAsync()`
2018
+ * method described below for async iteration which you can stop as needed.
2019
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2020
+ * for more details and examples.
2021
+ */
2022
+ listBackupSchedules(request?: protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, options?: CallOptions): Promise<[
2023
+ protos.google.spanner.admin.database.v1.IBackupSchedule[],
2024
+ protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest | null,
2025
+ protos.google.spanner.admin.database.v1.IListBackupSchedulesResponse
2026
+ ]>;
2027
+ listBackupSchedules(request: protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, protos.google.spanner.admin.database.v1.IListBackupSchedulesResponse | null | undefined, protos.google.spanner.admin.database.v1.IBackupSchedule>): void;
2028
+ listBackupSchedules(request: protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, callback: PaginationCallback<protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, protos.google.spanner.admin.database.v1.IListBackupSchedulesResponse | null | undefined, protos.google.spanner.admin.database.v1.IBackupSchedule>): void;
2029
+ /**
2030
+ * Equivalent to `listBackupSchedules`, but returns a NodeJS Stream object.
2031
+ * @param {Object} request
2032
+ * The request object that will be sent.
2033
+ * @param {string} request.parent
2034
+ * Required. Database is the parent resource whose backup schedules should be
2035
+ * listed. Values are of the form
2036
+ * projects/<project>/instances/<instance>/databases/<database>
2037
+ * @param {number} [request.pageSize]
2038
+ * Optional. Number of backup schedules to be returned in the response. If 0
2039
+ * or less, defaults to the server's maximum allowed page size.
2040
+ * @param {string} [request.pageToken]
2041
+ * Optional. If non-empty, `page_token` should contain a
2042
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse.next_page_token|next_page_token}
2043
+ * from a previous
2044
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse|ListBackupSchedulesResponse}
2045
+ * to the same `parent`.
2046
+ * @param {object} [options]
2047
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2048
+ * @returns {Stream}
2049
+ * An object stream which emits an object representing {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule} on 'data' event.
2050
+ * The client library will perform auto-pagination by default: it will call the API as many
2051
+ * times as needed. Note that it can affect your quota.
2052
+ * We recommend using `listBackupSchedulesAsync()`
2053
+ * method described below for async iteration which you can stop as needed.
2054
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2055
+ * for more details and examples.
2056
+ */
2057
+ listBackupSchedulesStream(request?: protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, options?: CallOptions): Transform;
2058
+ /**
2059
+ * Equivalent to `listBackupSchedules`, but returns an iterable object.
2060
+ *
2061
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2062
+ * @param {Object} request
2063
+ * The request object that will be sent.
2064
+ * @param {string} request.parent
2065
+ * Required. Database is the parent resource whose backup schedules should be
2066
+ * listed. Values are of the form
2067
+ * projects/<project>/instances/<instance>/databases/<database>
2068
+ * @param {number} [request.pageSize]
2069
+ * Optional. Number of backup schedules to be returned in the response. If 0
2070
+ * or less, defaults to the server's maximum allowed page size.
2071
+ * @param {string} [request.pageToken]
2072
+ * Optional. If non-empty, `page_token` should contain a
2073
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse.next_page_token|next_page_token}
2074
+ * from a previous
2075
+ * {@link protos.google.spanner.admin.database.v1.ListBackupSchedulesResponse|ListBackupSchedulesResponse}
2076
+ * to the same `parent`.
2077
+ * @param {object} [options]
2078
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2079
+ * @returns {Object}
2080
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2081
+ * When you iterate the returned iterable, each element will be an object representing
2082
+ * {@link protos.google.spanner.admin.database.v1.BackupSchedule|BackupSchedule}. The API will be called under the hood as needed, once per the page,
2083
+ * so you can stop the iteration when you don't need more results.
2084
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2085
+ * for more details and examples.
2086
+ * @example <caption>include:samples/generated/v1/database_admin.list_backup_schedules.js</caption>
2087
+ * region_tag:spanner_v1_generated_DatabaseAdmin_ListBackupSchedules_async
2088
+ */
2089
+ listBackupSchedulesAsync(request?: protos.google.spanner.admin.database.v1.IListBackupSchedulesRequest, options?: CallOptions): AsyncIterable<protos.google.spanner.admin.database.v1.IBackupSchedule>;
2090
+ /**
2091
+ * Gets the latest state of a long-running operation. Clients can use this
2092
+ * method to poll the operation result at intervals as recommended by the API
2093
+ * service.
2094
+ *
2095
+ * @param {Object} request - The request object that will be sent.
2096
+ * @param {string} request.name - The name of the operation resource.
2097
+ * @param {Object=} options
2098
+ * Optional parameters. You can override the default settings for this call,
2099
+ * e.g, timeout, retries, paginations, etc. See {@link
2100
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
2101
+ * for the details.
2102
+ * @param {function(?Error, ?Object)=} callback
2103
+ * The function which will be called with the result of the API call.
2104
+ *
2105
+ * The second parameter to the callback is an object representing
2106
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
2107
+ * @return {Promise} - The promise which resolves to an array.
2108
+ * The first element of the array is an object representing
2109
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
2110
+ * The promise has a method named "cancel" which cancels the ongoing API call.
2111
+ *
2112
+ * @example
2113
+ * ```
2114
+ * const client = longrunning.operationsClient();
2115
+ * const name = '';
2116
+ * const [response] = await client.getOperation({name});
2117
+ * // doThingsWith(response)
2118
+ * ```
2119
+ */
2120
+ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
2121
+ /**
2122
+ * Lists operations that match the specified filter in the request. If the
2123
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
2124
+ *
2125
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
2126
+ *
2127
+ * @param {Object} request - The request object that will be sent.
2128
+ * @param {string} request.name - The name of the operation collection.
2129
+ * @param {string} request.filter - The standard list filter.
2130
+ * @param {number=} request.pageSize -
2131
+ * The maximum number of resources contained in the underlying API
2132
+ * response. If page streaming is performed per-resource, this
2133
+ * parameter does not affect the return value. If page streaming is
2134
+ * performed per-page, this determines the maximum number of
2135
+ * resources in a page.
2136
+ * @param {Object=} options
2137
+ * Optional parameters. You can override the default settings for this call,
2138
+ * e.g, timeout, retries, paginations, etc. See {@link
2139
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
2140
+ * details.
2141
+ * @returns {Object}
2142
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
2143
+ *
2144
+ * @example
2145
+ * ```
2146
+ * const client = longrunning.operationsClient();
2147
+ * for await (const response of client.listOperationsAsync(request));
2148
+ * // doThingsWith(response)
2149
+ * ```
2150
+ */
2151
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
2152
+ /**
2153
+ * Starts asynchronous cancellation on a long-running operation. The server
2154
+ * makes a best effort to cancel the operation, but success is not
2155
+ * guaranteed. If the server doesn't support this method, it returns
2156
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
2157
+ * {@link Operations.GetOperation} or
2158
+ * other methods to check whether the cancellation succeeded or whether the
2159
+ * operation completed despite cancellation. On successful cancellation,
2160
+ * the operation is not deleted; instead, it becomes an operation with
2161
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
2162
+ * 1, corresponding to `Code.CANCELLED`.
2163
+ *
2164
+ * @param {Object} request - The request object that will be sent.
2165
+ * @param {string} request.name - The name of the operation resource to be cancelled.
2166
+ * @param {Object=} options
2167
+ * Optional parameters. You can override the default settings for this call,
2168
+ * e.g, timeout, retries, paginations, etc. See {@link
2169
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
2170
+ * details.
2171
+ * @param {function(?Error)=} callback
2172
+ * The function which will be called with the result of the API call.
2173
+ * @return {Promise} - The promise which resolves when API call finishes.
2174
+ * The promise has a method named "cancel" which cancels the ongoing API
2175
+ * call.
2176
+ *
2177
+ * @example
2178
+ * ```
2179
+ * const client = longrunning.operationsClient();
2180
+ * await client.cancelOperation({name: ''});
2181
+ * ```
2182
+ */
2183
+ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
2184
+ /**
2185
+ * Deletes a long-running operation. This method indicates that the client is
2186
+ * no longer interested in the operation result. It does not cancel the
2187
+ * operation. If the server doesn't support this method, it returns
2188
+ * `google.rpc.Code.UNIMPLEMENTED`.
2189
+ *
2190
+ * @param {Object} request - The request object that will be sent.
2191
+ * @param {string} request.name - The name of the operation resource to be deleted.
2192
+ * @param {Object=} options
2193
+ * Optional parameters. You can override the default settings for this call,
2194
+ * e.g, timeout, retries, paginations, etc. See {@link
2195
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
2196
+ * for the details.
2197
+ * @param {function(?Error)=} callback
2198
+ * The function which will be called with the result of the API call.
2199
+ * @return {Promise} - The promise which resolves when API call finishes.
2200
+ * The promise has a method named "cancel" which cancels the ongoing API
2201
+ * call.
2202
+ *
2203
+ * @example
2204
+ * ```
2205
+ * const client = longrunning.operationsClient();
2206
+ * await client.deleteOperation({name: ''});
2207
+ * ```
2208
+ */
2209
+ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
2210
+ /**
2211
+ * Return a fully-qualified backup resource name string.
2212
+ *
2213
+ * @param {string} project
2214
+ * @param {string} instance
2215
+ * @param {string} backup
2216
+ * @returns {string} Resource name string.
2217
+ */
2218
+ backupPath(project: string, instance: string, backup: string): string;
2219
+ /**
2220
+ * Parse the project from Backup resource.
2221
+ *
2222
+ * @param {string} backupName
2223
+ * A fully-qualified path representing Backup resource.
2224
+ * @returns {string} A string representing the project.
2225
+ */
2226
+ matchProjectFromBackupName(backupName: string): string | number;
2227
+ /**
2228
+ * Parse the instance from Backup resource.
2229
+ *
2230
+ * @param {string} backupName
2231
+ * A fully-qualified path representing Backup resource.
2232
+ * @returns {string} A string representing the instance.
2233
+ */
2234
+ matchInstanceFromBackupName(backupName: string): string | number;
2235
+ /**
2236
+ * Parse the backup from Backup resource.
2237
+ *
2238
+ * @param {string} backupName
2239
+ * A fully-qualified path representing Backup resource.
2240
+ * @returns {string} A string representing the backup.
2241
+ */
2242
+ matchBackupFromBackupName(backupName: string): string | number;
2243
+ /**
2244
+ * Return a fully-qualified backupSchedule resource name string.
2245
+ *
2246
+ * @param {string} project
2247
+ * @param {string} instance
2248
+ * @param {string} database
2249
+ * @param {string} schedule
2250
+ * @returns {string} Resource name string.
2251
+ */
2252
+ backupSchedulePath(project: string, instance: string, database: string, schedule: string): string;
2253
+ /**
2254
+ * Parse the project from BackupSchedule resource.
2255
+ *
2256
+ * @param {string} backupScheduleName
2257
+ * A fully-qualified path representing BackupSchedule resource.
2258
+ * @returns {string} A string representing the project.
2259
+ */
2260
+ matchProjectFromBackupScheduleName(backupScheduleName: string): string | number;
2261
+ /**
2262
+ * Parse the instance from BackupSchedule resource.
2263
+ *
2264
+ * @param {string} backupScheduleName
2265
+ * A fully-qualified path representing BackupSchedule resource.
2266
+ * @returns {string} A string representing the instance.
2267
+ */
2268
+ matchInstanceFromBackupScheduleName(backupScheduleName: string): string | number;
2269
+ /**
2270
+ * Parse the database from BackupSchedule resource.
2271
+ *
2272
+ * @param {string} backupScheduleName
2273
+ * A fully-qualified path representing BackupSchedule resource.
2274
+ * @returns {string} A string representing the database.
2275
+ */
2276
+ matchDatabaseFromBackupScheduleName(backupScheduleName: string): string | number;
2277
+ /**
2278
+ * Parse the schedule from BackupSchedule resource.
2279
+ *
2280
+ * @param {string} backupScheduleName
2281
+ * A fully-qualified path representing BackupSchedule resource.
2282
+ * @returns {string} A string representing the schedule.
2283
+ */
2284
+ matchScheduleFromBackupScheduleName(backupScheduleName: string): string | number;
2285
+ /**
2286
+ * Return a fully-qualified cryptoKey resource name string.
2287
+ *
2288
+ * @param {string} project
2289
+ * @param {string} location
2290
+ * @param {string} key_ring
2291
+ * @param {string} crypto_key
2292
+ * @returns {string} Resource name string.
2293
+ */
2294
+ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string;
2295
+ /**
2296
+ * Parse the project from CryptoKey resource.
2297
+ *
2298
+ * @param {string} cryptoKeyName
2299
+ * A fully-qualified path representing CryptoKey resource.
2300
+ * @returns {string} A string representing the project.
2301
+ */
2302
+ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;
2303
+ /**
2304
+ * Parse the location from CryptoKey resource.
2305
+ *
2306
+ * @param {string} cryptoKeyName
2307
+ * A fully-qualified path representing CryptoKey resource.
2308
+ * @returns {string} A string representing the location.
2309
+ */
2310
+ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;
2311
+ /**
2312
+ * Parse the key_ring from CryptoKey resource.
2313
+ *
2314
+ * @param {string} cryptoKeyName
2315
+ * A fully-qualified path representing CryptoKey resource.
2316
+ * @returns {string} A string representing the key_ring.
2317
+ */
2318
+ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number;
2319
+ /**
2320
+ * Parse the crypto_key from CryptoKey resource.
2321
+ *
2322
+ * @param {string} cryptoKeyName
2323
+ * A fully-qualified path representing CryptoKey resource.
2324
+ * @returns {string} A string representing the crypto_key.
2325
+ */
2326
+ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number;
2327
+ /**
2328
+ * Return a fully-qualified database resource name string.
2329
+ *
2330
+ * @param {string} project
2331
+ * @param {string} instance
2332
+ * @param {string} database
2333
+ * @returns {string} Resource name string.
2334
+ */
2335
+ databasePath(project: string, instance: string, database: string): string;
2336
+ /**
2337
+ * Parse the project from Database resource.
2338
+ *
2339
+ * @param {string} databaseName
2340
+ * A fully-qualified path representing Database resource.
2341
+ * @returns {string} A string representing the project.
2342
+ */
2343
+ matchProjectFromDatabaseName(databaseName: string): string | number;
2344
+ /**
2345
+ * Parse the instance from Database resource.
2346
+ *
2347
+ * @param {string} databaseName
2348
+ * A fully-qualified path representing Database resource.
2349
+ * @returns {string} A string representing the instance.
2350
+ */
2351
+ matchInstanceFromDatabaseName(databaseName: string): string | number;
2352
+ /**
2353
+ * Parse the database from Database resource.
2354
+ *
2355
+ * @param {string} databaseName
2356
+ * A fully-qualified path representing Database resource.
2357
+ * @returns {string} A string representing the database.
2358
+ */
2359
+ matchDatabaseFromDatabaseName(databaseName: string): string | number;
2360
+ /**
2361
+ * Return a fully-qualified databaseRole resource name string.
2362
+ *
2363
+ * @param {string} project
2364
+ * @param {string} instance
2365
+ * @param {string} database
2366
+ * @param {string} role
2367
+ * @returns {string} Resource name string.
2368
+ */
2369
+ databaseRolePath(project: string, instance: string, database: string, role: string): string;
2370
+ /**
2371
+ * Parse the project from DatabaseRole resource.
2372
+ *
2373
+ * @param {string} databaseRoleName
2374
+ * A fully-qualified path representing DatabaseRole resource.
2375
+ * @returns {string} A string representing the project.
2376
+ */
2377
+ matchProjectFromDatabaseRoleName(databaseRoleName: string): string | number;
2378
+ /**
2379
+ * Parse the instance from DatabaseRole resource.
2380
+ *
2381
+ * @param {string} databaseRoleName
2382
+ * A fully-qualified path representing DatabaseRole resource.
2383
+ * @returns {string} A string representing the instance.
2384
+ */
2385
+ matchInstanceFromDatabaseRoleName(databaseRoleName: string): string | number;
2386
+ /**
2387
+ * Parse the database from DatabaseRole resource.
2388
+ *
2389
+ * @param {string} databaseRoleName
2390
+ * A fully-qualified path representing DatabaseRole resource.
2391
+ * @returns {string} A string representing the database.
2392
+ */
2393
+ matchDatabaseFromDatabaseRoleName(databaseRoleName: string): string | number;
2394
+ /**
2395
+ * Parse the role from DatabaseRole resource.
2396
+ *
2397
+ * @param {string} databaseRoleName
2398
+ * A fully-qualified path representing DatabaseRole resource.
2399
+ * @returns {string} A string representing the role.
2400
+ */
2401
+ matchRoleFromDatabaseRoleName(databaseRoleName: string): string | number;
2402
+ /**
2403
+ * Return a fully-qualified instance resource name string.
2404
+ *
2405
+ * @param {string} project
2406
+ * @param {string} instance
2407
+ * @returns {string} Resource name string.
2408
+ */
2409
+ instancePath(project: string, instance: string): string;
2410
+ /**
2411
+ * Parse the project from Instance resource.
2412
+ *
2413
+ * @param {string} instanceName
2414
+ * A fully-qualified path representing Instance resource.
2415
+ * @returns {string} A string representing the project.
2416
+ */
2417
+ matchProjectFromInstanceName(instanceName: string): string | number;
2418
+ /**
2419
+ * Parse the instance from Instance resource.
2420
+ *
2421
+ * @param {string} instanceName
2422
+ * A fully-qualified path representing Instance resource.
2423
+ * @returns {string} A string representing the instance.
2424
+ */
2425
+ matchInstanceFromInstanceName(instanceName: string): string | number;
2426
+ /**
2427
+ * Terminate the gRPC channel and close the client.
2428
+ *
2429
+ * The client will no longer be usable and all future behavior is undefined.
2430
+ * @returns {Promise} A promise that resolves when the client is closed.
2431
+ */
2432
+ close(): Promise<void>;
2433
+ }