@googleapis/spanner 12.3.1 → 12.4.1

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.
package/build/v1.d.ts CHANGED
@@ -195,6 +195,18 @@ export declare namespace spanner_v1 {
195
195
  * Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas.
196
196
  */
197
197
  autoscalingTargetHighPriorityCpuUtilizationPercent?: number | null;
198
+ /**
199
+ * Optional. If specified, overrides the autoscaling target `total_cpu_utilization_percent` in the top-level autoscaling configuration for the selected replicas.
200
+ */
201
+ autoscalingTargetTotalCpuUtilizationPercent?: number | null;
202
+ /**
203
+ * Optional. If true, disables high priority CPU autoscaling for the selected replicas and ignores high_priority_cpu_utilization_percent in the top-level autoscaling configuration. When setting this field to true, setting autoscaling_target_high_priority_cpu_utilization_percent field to a non-zero value for the same replica is not supported. If false, the autoscaling_target_high_priority_cpu_utilization_percent field in the replica will be used if set to a non-zero value. Otherwise, the high_priority_cpu_utilization_percent field in the top-level autoscaling configuration will be used. Setting both disable_high_priority_cpu_autoscaling and disable_total_cpu_autoscaling to true for the same replica is not supported.
204
+ */
205
+ disableHighPriorityCpuAutoscaling?: boolean | null;
206
+ /**
207
+ * Optional. If true, disables total CPU autoscaling for the selected replicas and ignores total_cpu_utilization_percent in the top-level autoscaling configuration. When setting this field to true, setting autoscaling_target_total_cpu_utilization_percent field to a non-zero value for the same replica is not supported. If false, the autoscaling_target_total_cpu_utilization_percent field in the replica will be used if set to a non-zero value. Otherwise, the total_cpu_utilization_percent field in the top-level autoscaling configuration will be used. Setting both disable_high_priority_cpu_autoscaling and disable_total_cpu_autoscaling to true for the same replica is not supported.
208
+ */
209
+ disableTotalCpuAutoscaling?: boolean | null;
198
210
  }
199
211
  /**
200
212
  * The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
@@ -222,13 +234,17 @@ export declare namespace spanner_v1 {
222
234
  */
223
235
  export interface Schema$AutoscalingTargets {
224
236
  /**
225
- * Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
237
+ * Optional. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler skips scaling based on high priority CPU utilization.
226
238
  */
227
239
  highPriorityCpuUtilizationPercent?: number | null;
228
240
  /**
229
241
  * Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 99] inclusive.
230
242
  */
231
243
  storageUtilizationPercent?: number | null;
244
+ /**
245
+ * Optional. The target total CPU utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler skips scaling based on total CPU utilization. If both `high_priority_cpu_utilization_percent` and `total_cpu_utilization_percent` are specified, the autoscaler provisions the larger of the two required compute capacities to satisfy both targets.
246
+ */
247
+ totalCpuUtilizationPercent?: number | null;
232
248
  }
233
249
  /**
234
250
  * A backup of a Cloud Spanner database.
@@ -243,7 +259,7 @@ export declare namespace spanner_v1 {
243
259
  */
244
260
  createTime?: string | null;
245
261
  /**
246
- * Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
262
+ * Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project\}/instances/{instance\}/databases/{database\}`.
247
263
  */
248
264
  database?: string | null;
249
265
  /**
@@ -283,7 +299,11 @@ export declare namespace spanner_v1 {
283
299
  */
284
300
  maxExpireTime?: string | null;
285
301
  /**
286
- * Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
302
+ * Output only. The minimum edition required to successfully restore the backup. Populated only if the edition is Enterprise or Enterprise Plus.
303
+ */
304
+ minimumRestorableEdition?: string | null;
305
+ /**
306
+ * Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}`.
287
307
  */
288
308
  name?: string | null;
289
309
  /**
@@ -291,11 +311,11 @@ export declare namespace spanner_v1 {
291
311
  */
292
312
  oldestVersionTime?: string | null;
293
313
  /**
294
- * Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
314
+ * Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
295
315
  */
296
316
  referencingBackups?: string[] | null;
297
317
  /**
298
- * Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
318
+ * Output only. The names of the restored databases that reference the backup. The database names are of the form `projects/{project\}/instances/{instance\}/databases/{database\}`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
299
319
  */
300
320
  referencingDatabases?: string[] | null;
301
321
  /**
@@ -337,7 +357,7 @@ export declare namespace spanner_v1 {
337
357
  */
338
358
  export interface Schema$BackupInstancePartition {
339
359
  /**
340
- * A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/`
360
+ * A unique identifier for the instance partition. Values are of the form `projects/{project\}/instances/{instance\}/instancePartitions/{instance_partition_id\}`
341
361
  */
342
362
  instancePartition?: string | null;
343
363
  }
@@ -427,7 +447,7 @@ export declare namespace spanner_v1 {
427
447
  */
428
448
  export interface Schema$BatchWriteResponse {
429
449
  /**
430
- * The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`, absent otherwise.
450
+ * The commit timestamp of the transaction that applied this batch. Present if status is OK and the mutation groups were applied, absent otherwise. For mutation groups with conditions, a status=OK and missing commit_timestamp means that the mutation groups were not applied due to the condition not being satisfied after evaluation.
431
451
  */
432
452
  commitTimestamp?: string | null;
433
453
  /**
@@ -549,6 +569,17 @@ export declare namespace spanner_v1 {
549
569
  */
550
570
  variable?: string | null;
551
571
  }
572
+ /**
573
+ * Container for various pieces of client-owned context attached to a request.
574
+ */
575
+ export interface Schema$ClientContext {
576
+ /**
577
+ * Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).
578
+ */
579
+ secureContext?: {
580
+ [key: string]: any;
581
+ } | null;
582
+ }
552
583
  /**
553
584
  * Metadata for a column.
554
585
  */
@@ -680,11 +711,11 @@ export declare namespace spanner_v1 {
680
711
  */
681
712
  encryptionType?: string | null;
682
713
  /**
683
- * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
714
+ * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`.
684
715
  */
685
716
  kmsKeyName?: string | null;
686
717
  /**
687
- * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in any order. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
718
+ * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`. KMS keys specified can be in any order. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
688
719
  */
689
720
  kmsKeyNames?: string[] | null;
690
721
  }
@@ -697,7 +728,7 @@ export declare namespace spanner_v1 {
697
728
  */
698
729
  cancelTime?: string | null;
699
730
  /**
700
- * The name of the backup being created through the copy operation. Values are of the form `projects//instances//backups/`.
731
+ * The name of the backup being created through the copy operation. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
701
732
  */
702
733
  name?: string | null;
703
734
  /**
@@ -705,7 +736,7 @@ export declare namespace spanner_v1 {
705
736
  */
706
737
  progress?: Schema$OperationProgress;
707
738
  /**
708
- * The name of the source backup that is being copied. Values are of the form `projects//instances//backups/`.
739
+ * The name of the source backup that is being copied. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
709
740
  */
710
741
  sourceBackup?: string | null;
711
742
  }
@@ -714,7 +745,7 @@ export declare namespace spanner_v1 {
714
745
  */
715
746
  export interface Schema$CopyBackupRequest {
716
747
  /**
717
- * Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects//instances//backups/`.
748
+ * Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
718
749
  */
719
750
  backupId?: string | null;
720
751
  /**
@@ -726,7 +757,7 @@ export declare namespace spanner_v1 {
726
757
  */
727
758
  expireTime?: string | null;
728
759
  /**
729
- * Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects//instances//backups/`.
760
+ * Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/{project\}/instances/{instance\}/backups/{backup\}`.
730
761
  */
731
762
  sourceBackup?: string | null;
732
763
  }
@@ -739,11 +770,11 @@ export declare namespace spanner_v1 {
739
770
  */
740
771
  encryptionType?: string | null;
741
772
  /**
742
- * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
773
+ * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`.
743
774
  */
744
775
  kmsKeyName?: string | null;
745
776
  /**
746
- * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
777
+ * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
747
778
  */
748
779
  kmsKeyNames?: string[] | null;
749
780
  }
@@ -2353,13 +2384,13 @@ export declare namespace spanner_v1 {
2353
2384
  */
2354
2385
  export interface Schema$PartitionQueryRequest {
2355
2386
  /**
2356
- * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters.
2387
+ * Optional. Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters.
2357
2388
  */
2358
2389
  params?: {
2359
2390
  [key: string]: any;
2360
2391
  } | null;
2361
2392
  /**
2362
- * It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.
2393
+ * Optional. It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.
2363
2394
  */
2364
2395
  paramTypes?: {
2365
2396
  [key: string]: Schema$Type;
@@ -2679,7 +2710,7 @@ export declare namespace spanner_v1 {
2679
2710
  */
2680
2711
  multiplexedSessionPreviousTransactionId?: string | null;
2681
2712
  /**
2682
- * Read lock mode for the transaction.
2713
+ * The read lock mode for the transaction.
2683
2714
  */
2684
2715
  readLockMode?: string | null;
2685
2716
  }
@@ -2731,6 +2762,10 @@ export declare namespace spanner_v1 {
2731
2762
  * Common request options for various APIs.
2732
2763
  */
2733
2764
  export interface Schema$RequestOptions {
2765
+ /**
2766
+ * Optional. Optional context that may be needed for some requests.
2767
+ */
2768
+ clientContext?: Schema$ClientContext;
2734
2769
  /**
2735
2770
  * Priority for the request.
2736
2771
  */
@@ -5384,7 +5419,7 @@ export declare namespace spanner_v1 {
5384
5419
  * pageSize: 'placeholder-value',
5385
5420
  * // If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
5386
5421
  * pageToken: 'placeholder-value',
5387
- * // Required. The instance of the backup operations. Values are of the form `projects//instances/`.
5422
+ * // Required. The instance of the backup operations. Values are of the form `projects/{project\}/instances/{instance\}`.
5388
5423
  * parent: 'projects/my-project/instances/my-instance',
5389
5424
  * });
5390
5425
  * console.log(res.data);
@@ -5429,7 +5464,7 @@ export declare namespace spanner_v1 {
5429
5464
  */
5430
5465
  pageToken?: string;
5431
5466
  /**
5432
- * Required. The instance of the backup operations. Values are of the form `projects//instances/`.
5467
+ * Required. The instance of the backup operations. Values are of the form `projects/{project\}/instances/{instance\}`.
5433
5468
  */
5434
5469
  parent?: string;
5435
5470
  }
@@ -5471,7 +5506,7 @@ export declare namespace spanner_v1 {
5471
5506
  *
5472
5507
  * // Do the magic
5473
5508
  * const res = await spanner.projects.instances.backups.copy({
5474
- * // Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`.
5509
+ * // Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project\}/instances/{instance\}`.
5475
5510
  * parent: 'projects/my-project/instances/my-instance',
5476
5511
  *
5477
5512
  * // Request body metadata
@@ -5549,15 +5584,15 @@ export declare namespace spanner_v1 {
5549
5584
  *
5550
5585
  * // Do the magic
5551
5586
  * const res = await spanner.projects.instances.backups.create({
5552
- * // Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`.
5587
+ * // Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects/{project\}/instances/{instance\}/backups/{backup_id\}`.
5553
5588
  * backupId: 'placeholder-value',
5554
5589
  * // Required. The encryption type of the backup.
5555
5590
  * 'encryptionConfig.encryptionType': 'placeholder-value',
5556
- * // Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
5591
+ * // Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`.
5557
5592
  * 'encryptionConfig.kmsKeyName': 'placeholder-value',
5558
- * // Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
5593
+ * // Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
5559
5594
  * 'encryptionConfig.kmsKeyNames': 'placeholder-value',
5560
- * // Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`.
5595
+ * // Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects/{project\}/instances/{instance\}`.
5561
5596
  * parent: 'projects/my-project/instances/my-instance',
5562
5597
  *
5563
5598
  * // Request body metadata
@@ -5576,6 +5611,7 @@ export declare namespace spanner_v1 {
5576
5611
  * // "incrementalBackupChainId": "my_incrementalBackupChainId",
5577
5612
  * // "instancePartitions": [],
5578
5613
  * // "maxExpireTime": "my_maxExpireTime",
5614
+ * // "minimumRestorableEdition": "my_minimumRestorableEdition",
5579
5615
  * // "name": "my_name",
5580
5616
  * // "oldestVersionTime": "my_oldestVersionTime",
5581
5617
  * // "referencingBackups": [],
@@ -5650,7 +5686,7 @@ export declare namespace spanner_v1 {
5650
5686
  *
5651
5687
  * // Do the magic
5652
5688
  * const res = await spanner.projects.instances.backups.delete({
5653
- * // Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`.
5689
+ * // Required. Name of the backup to delete. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
5654
5690
  * name: 'projects/my-project/instances/my-instance/backups/my-backup',
5655
5691
  * });
5656
5692
  * console.log(res.data);
@@ -5711,7 +5747,7 @@ export declare namespace spanner_v1 {
5711
5747
  *
5712
5748
  * // Do the magic
5713
5749
  * const res = await spanner.projects.instances.backups.get({
5714
- * // Required. Name of the backup. Values are of the form `projects//instances//backups/`.
5750
+ * // Required. Name of the backup. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
5715
5751
  * name: 'projects/my-project/instances/my-instance/backups/my-backup',
5716
5752
  * });
5717
5753
  * console.log(res.data);
@@ -5730,6 +5766,7 @@ export declare namespace spanner_v1 {
5730
5766
  * // "incrementalBackupChainId": "my_incrementalBackupChainId",
5731
5767
  * // "instancePartitions": [],
5732
5768
  * // "maxExpireTime": "my_maxExpireTime",
5769
+ * // "minimumRestorableEdition": "my_minimumRestorableEdition",
5733
5770
  * // "name": "my_name",
5734
5771
  * // "oldestVersionTime": "my_oldestVersionTime",
5735
5772
  * // "referencingBackups": [],
@@ -5871,7 +5908,7 @@ export declare namespace spanner_v1 {
5871
5908
  * pageSize: 'placeholder-value',
5872
5909
  * // If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`.
5873
5910
  * pageToken: 'placeholder-value',
5874
- * // Required. The instance to list backups from. Values are of the form `projects//instances/`.
5911
+ * // Required. The instance to list backups from. Values are of the form `projects/{project\}/instances/{instance\}`.
5875
5912
  * parent: 'projects/my-project/instances/my-instance',
5876
5913
  * });
5877
5914
  * console.log(res.data);
@@ -5935,7 +5972,7 @@ export declare namespace spanner_v1 {
5935
5972
  *
5936
5973
  * // Do the magic
5937
5974
  * const res = await spanner.projects.instances.backups.patch({
5938
- * // Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
5975
+ * // Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}`.
5939
5976
  * name: 'projects/my-project/instances/my-instance/backups/my-backup',
5940
5977
  * // Required. A mask specifying which fields (for example, `expire_time`) in the backup resource should be updated. This mask is relative to the backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
5941
5978
  * updateMask: 'placeholder-value',
@@ -5956,6 +5993,7 @@ export declare namespace spanner_v1 {
5956
5993
  * // "incrementalBackupChainId": "my_incrementalBackupChainId",
5957
5994
  * // "instancePartitions": [],
5958
5995
  * // "maxExpireTime": "my_maxExpireTime",
5996
+ * // "minimumRestorableEdition": "my_minimumRestorableEdition",
5959
5997
  * // "name": "my_name",
5960
5998
  * // "oldestVersionTime": "my_oldestVersionTime",
5961
5999
  * // "referencingBackups": [],
@@ -5982,6 +6020,7 @@ export declare namespace spanner_v1 {
5982
6020
  * // "incrementalBackupChainId": "my_incrementalBackupChainId",
5983
6021
  * // "instancePartitions": [],
5984
6022
  * // "maxExpireTime": "my_maxExpireTime",
6023
+ * // "minimumRestorableEdition": "my_minimumRestorableEdition",
5985
6024
  * // "name": "my_name",
5986
6025
  * // "oldestVersionTime": "my_oldestVersionTime",
5987
6026
  * // "referencingBackups": [],
@@ -6157,7 +6196,7 @@ export declare namespace spanner_v1 {
6157
6196
  }
6158
6197
  export interface Params$Resource$Projects$Instances$Backups$Copy extends StandardParameters {
6159
6198
  /**
6160
- * Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`.
6199
+ * Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project\}/instances/{instance\}`.
6161
6200
  */
6162
6201
  parent?: string;
6163
6202
  /**
@@ -6167,7 +6206,7 @@ export declare namespace spanner_v1 {
6167
6206
  }
6168
6207
  export interface Params$Resource$Projects$Instances$Backups$Create extends StandardParameters {
6169
6208
  /**
6170
- * Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`.
6209
+ * Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects/{project\}/instances/{instance\}/backups/{backup_id\}`.
6171
6210
  */
6172
6211
  backupId?: string;
6173
6212
  /**
@@ -6175,15 +6214,15 @@ export declare namespace spanner_v1 {
6175
6214
  */
6176
6215
  'encryptionConfig.encryptionType'?: string;
6177
6216
  /**
6178
- * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
6217
+ * Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`.
6179
6218
  */
6180
6219
  'encryptionConfig.kmsKeyName'?: string;
6181
6220
  /**
6182
- * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
6221
+ * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{kms_key_name\}`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.
6183
6222
  */
6184
6223
  'encryptionConfig.kmsKeyNames'?: string[];
6185
6224
  /**
6186
- * Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`.
6225
+ * Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects/{project\}/instances/{instance\}`.
6187
6226
  */
6188
6227
  parent?: string;
6189
6228
  /**
@@ -6193,13 +6232,13 @@ export declare namespace spanner_v1 {
6193
6232
  }
6194
6233
  export interface Params$Resource$Projects$Instances$Backups$Delete extends StandardParameters {
6195
6234
  /**
6196
- * Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`.
6235
+ * Required. Name of the backup to delete. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
6197
6236
  */
6198
6237
  name?: string;
6199
6238
  }
6200
6239
  export interface Params$Resource$Projects$Instances$Backups$Get extends StandardParameters {
6201
6240
  /**
6202
- * Required. Name of the backup. Values are of the form `projects//instances//backups/`.
6241
+ * Required. Name of the backup. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
6203
6242
  */
6204
6243
  name?: string;
6205
6244
  }
@@ -6227,13 +6266,13 @@ export declare namespace spanner_v1 {
6227
6266
  */
6228
6267
  pageToken?: string;
6229
6268
  /**
6230
- * Required. The instance to list backups from. Values are of the form `projects//instances/`.
6269
+ * Required. The instance to list backups from. Values are of the form `projects/{project\}/instances/{instance\}`.
6231
6270
  */
6232
6271
  parent?: string;
6233
6272
  }
6234
6273
  export interface Params$Resource$Projects$Instances$Backups$Patch extends StandardParameters {
6235
6274
  /**
6236
- * Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
6275
+ * Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}`.
6237
6276
  */
6238
6277
  name?: string;
6239
6278
  /**