@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/CHANGELOG.md +15 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +77 -38
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +75 -38
package/v1.ts
CHANGED
|
@@ -245,6 +245,18 @@ export namespace spanner_v1 {
|
|
|
245
245
|
* Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas.
|
|
246
246
|
*/
|
|
247
247
|
autoscalingTargetHighPriorityCpuUtilizationPercent?: number | null;
|
|
248
|
+
/**
|
|
249
|
+
* Optional. If specified, overrides the autoscaling target `total_cpu_utilization_percent` in the top-level autoscaling configuration for the selected replicas.
|
|
250
|
+
*/
|
|
251
|
+
autoscalingTargetTotalCpuUtilizationPercent?: number | null;
|
|
252
|
+
/**
|
|
253
|
+
* 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.
|
|
254
|
+
*/
|
|
255
|
+
disableHighPriorityCpuAutoscaling?: boolean | null;
|
|
256
|
+
/**
|
|
257
|
+
* 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.
|
|
258
|
+
*/
|
|
259
|
+
disableTotalCpuAutoscaling?: boolean | null;
|
|
248
260
|
}
|
|
249
261
|
/**
|
|
250
262
|
* 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.
|
|
@@ -272,13 +284,17 @@ export namespace spanner_v1 {
|
|
|
272
284
|
*/
|
|
273
285
|
export interface Schema$AutoscalingTargets {
|
|
274
286
|
/**
|
|
275
|
-
*
|
|
287
|
+
* 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.
|
|
276
288
|
*/
|
|
277
289
|
highPriorityCpuUtilizationPercent?: number | null;
|
|
278
290
|
/**
|
|
279
291
|
* 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.
|
|
280
292
|
*/
|
|
281
293
|
storageUtilizationPercent?: number | null;
|
|
294
|
+
/**
|
|
295
|
+
* 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.
|
|
296
|
+
*/
|
|
297
|
+
totalCpuUtilizationPercent?: number | null;
|
|
282
298
|
}
|
|
283
299
|
/**
|
|
284
300
|
* A backup of a Cloud Spanner database.
|
|
@@ -293,7 +309,7 @@ export namespace spanner_v1 {
|
|
|
293
309
|
*/
|
|
294
310
|
createTime?: string | null;
|
|
295
311
|
/**
|
|
296
|
-
* 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
|
|
312
|
+
* 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\}`.
|
|
297
313
|
*/
|
|
298
314
|
database?: string | null;
|
|
299
315
|
/**
|
|
@@ -333,7 +349,11 @@ export namespace spanner_v1 {
|
|
|
333
349
|
*/
|
|
334
350
|
maxExpireTime?: string | null;
|
|
335
351
|
/**
|
|
336
|
-
* Output only
|
|
352
|
+
* Output only. The minimum edition required to successfully restore the backup. Populated only if the edition is Enterprise or Enterprise Plus.
|
|
353
|
+
*/
|
|
354
|
+
minimumRestorableEdition?: string | null;
|
|
355
|
+
/**
|
|
356
|
+
* 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\}`.
|
|
337
357
|
*/
|
|
338
358
|
name?: string | null;
|
|
339
359
|
/**
|
|
@@ -341,11 +361,11 @@ export namespace spanner_v1 {
|
|
|
341
361
|
*/
|
|
342
362
|
oldestVersionTime?: string | null;
|
|
343
363
|
/**
|
|
344
|
-
* Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects
|
|
364
|
+
* 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.
|
|
345
365
|
*/
|
|
346
366
|
referencingBackups?: string[] | null;
|
|
347
367
|
/**
|
|
348
|
-
* Output only. The names of the restored databases that reference the backup. The database names are of the form `projects
|
|
368
|
+
* 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.
|
|
349
369
|
*/
|
|
350
370
|
referencingDatabases?: string[] | null;
|
|
351
371
|
/**
|
|
@@ -387,7 +407,7 @@ export namespace spanner_v1 {
|
|
|
387
407
|
*/
|
|
388
408
|
export interface Schema$BackupInstancePartition {
|
|
389
409
|
/**
|
|
390
|
-
* A unique identifier for the instance partition. Values are of the form `projects
|
|
410
|
+
* A unique identifier for the instance partition. Values are of the form `projects/{project\}/instances/{instance\}/instancePartitions/{instance_partition_id\}`
|
|
391
411
|
*/
|
|
392
412
|
instancePartition?: string | null;
|
|
393
413
|
}
|
|
@@ -477,7 +497,7 @@ export namespace spanner_v1 {
|
|
|
477
497
|
*/
|
|
478
498
|
export interface Schema$BatchWriteResponse {
|
|
479
499
|
/**
|
|
480
|
-
* The commit timestamp of the transaction that applied this batch. Present if
|
|
500
|
+
* 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.
|
|
481
501
|
*/
|
|
482
502
|
commitTimestamp?: string | null;
|
|
483
503
|
/**
|
|
@@ -599,6 +619,15 @@ export namespace spanner_v1 {
|
|
|
599
619
|
*/
|
|
600
620
|
variable?: string | null;
|
|
601
621
|
}
|
|
622
|
+
/**
|
|
623
|
+
* Container for various pieces of client-owned context attached to a request.
|
|
624
|
+
*/
|
|
625
|
+
export interface Schema$ClientContext {
|
|
626
|
+
/**
|
|
627
|
+
* 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).
|
|
628
|
+
*/
|
|
629
|
+
secureContext?: {[key: string]: any} | null;
|
|
630
|
+
}
|
|
602
631
|
/**
|
|
603
632
|
* Metadata for a column.
|
|
604
633
|
*/
|
|
@@ -730,11 +759,11 @@ export namespace spanner_v1 {
|
|
|
730
759
|
*/
|
|
731
760
|
encryptionType?: string | null;
|
|
732
761
|
/**
|
|
733
|
-
* 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
|
|
762
|
+
* 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\}`.
|
|
734
763
|
*/
|
|
735
764
|
kmsKeyName?: string | null;
|
|
736
765
|
/**
|
|
737
|
-
* Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
766
|
+
* 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.
|
|
738
767
|
*/
|
|
739
768
|
kmsKeyNames?: string[] | null;
|
|
740
769
|
}
|
|
@@ -747,7 +776,7 @@ export namespace spanner_v1 {
|
|
|
747
776
|
*/
|
|
748
777
|
cancelTime?: string | null;
|
|
749
778
|
/**
|
|
750
|
-
* The name of the backup being created through the copy operation. Values are of the form `projects
|
|
779
|
+
* The name of the backup being created through the copy operation. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
751
780
|
*/
|
|
752
781
|
name?: string | null;
|
|
753
782
|
/**
|
|
@@ -755,7 +784,7 @@ export namespace spanner_v1 {
|
|
|
755
784
|
*/
|
|
756
785
|
progress?: Schema$OperationProgress;
|
|
757
786
|
/**
|
|
758
|
-
* The name of the source backup that is being copied. Values are of the form `projects
|
|
787
|
+
* The name of the source backup that is being copied. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
759
788
|
*/
|
|
760
789
|
sourceBackup?: string | null;
|
|
761
790
|
}
|
|
@@ -764,7 +793,7 @@ export namespace spanner_v1 {
|
|
|
764
793
|
*/
|
|
765
794
|
export interface Schema$CopyBackupRequest {
|
|
766
795
|
/**
|
|
767
|
-
* Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects
|
|
796
|
+
* 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\}`.
|
|
768
797
|
*/
|
|
769
798
|
backupId?: string | null;
|
|
770
799
|
/**
|
|
@@ -776,7 +805,7 @@ export namespace spanner_v1 {
|
|
|
776
805
|
*/
|
|
777
806
|
expireTime?: string | null;
|
|
778
807
|
/**
|
|
779
|
-
* 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
|
|
808
|
+
* 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\}`.
|
|
780
809
|
*/
|
|
781
810
|
sourceBackup?: string | null;
|
|
782
811
|
}
|
|
@@ -789,11 +818,11 @@ export namespace spanner_v1 {
|
|
|
789
818
|
*/
|
|
790
819
|
encryptionType?: string | null;
|
|
791
820
|
/**
|
|
792
|
-
* 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
|
|
821
|
+
* 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\}`.
|
|
793
822
|
*/
|
|
794
823
|
kmsKeyName?: string | null;
|
|
795
824
|
/**
|
|
796
|
-
* Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
825
|
+
* 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.
|
|
797
826
|
*/
|
|
798
827
|
kmsKeyNames?: string[] | null;
|
|
799
828
|
}
|
|
@@ -2376,11 +2405,11 @@ export namespace spanner_v1 {
|
|
|
2376
2405
|
*/
|
|
2377
2406
|
export interface Schema$PartitionQueryRequest {
|
|
2378
2407
|
/**
|
|
2379
|
-
* 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.
|
|
2408
|
+
* 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.
|
|
2380
2409
|
*/
|
|
2381
2410
|
params?: {[key: string]: any} | null;
|
|
2382
2411
|
/**
|
|
2383
|
-
* 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.
|
|
2412
|
+
* 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.
|
|
2384
2413
|
*/
|
|
2385
2414
|
paramTypes?: {[key: string]: Schema$Type} | null;
|
|
2386
2415
|
/**
|
|
@@ -2694,7 +2723,7 @@ export namespace spanner_v1 {
|
|
|
2694
2723
|
*/
|
|
2695
2724
|
multiplexedSessionPreviousTransactionId?: string | null;
|
|
2696
2725
|
/**
|
|
2697
|
-
*
|
|
2726
|
+
* The read lock mode for the transaction.
|
|
2698
2727
|
*/
|
|
2699
2728
|
readLockMode?: string | null;
|
|
2700
2729
|
}
|
|
@@ -2746,6 +2775,10 @@ export namespace spanner_v1 {
|
|
|
2746
2775
|
* Common request options for various APIs.
|
|
2747
2776
|
*/
|
|
2748
2777
|
export interface Schema$RequestOptions {
|
|
2778
|
+
/**
|
|
2779
|
+
* Optional. Optional context that may be needed for some requests.
|
|
2780
|
+
*/
|
|
2781
|
+
clientContext?: Schema$ClientContext;
|
|
2749
2782
|
/**
|
|
2750
2783
|
* Priority for the request.
|
|
2751
2784
|
*/
|
|
@@ -7211,7 +7244,7 @@ export namespace spanner_v1 {
|
|
|
7211
7244
|
* pageSize: 'placeholder-value',
|
|
7212
7245
|
* // If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
|
|
7213
7246
|
* pageToken: 'placeholder-value',
|
|
7214
|
-
* // Required. The instance of the backup operations. Values are of the form `projects
|
|
7247
|
+
* // Required. The instance of the backup operations. Values are of the form `projects/{project\}/instances/{instance\}`.
|
|
7215
7248
|
* parent: 'projects/my-project/instances/my-instance',
|
|
7216
7249
|
* });
|
|
7217
7250
|
* console.log(res.data);
|
|
@@ -7339,7 +7372,7 @@ export namespace spanner_v1 {
|
|
|
7339
7372
|
*/
|
|
7340
7373
|
pageToken?: string;
|
|
7341
7374
|
/**
|
|
7342
|
-
* Required. The instance of the backup operations. Values are of the form `projects
|
|
7375
|
+
* Required. The instance of the backup operations. Values are of the form `projects/{project\}/instances/{instance\}`.
|
|
7343
7376
|
*/
|
|
7344
7377
|
parent?: string;
|
|
7345
7378
|
}
|
|
@@ -7388,7 +7421,7 @@ export namespace spanner_v1 {
|
|
|
7388
7421
|
*
|
|
7389
7422
|
* // Do the magic
|
|
7390
7423
|
* const res = await spanner.projects.instances.backups.copy({
|
|
7391
|
-
* // Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects
|
|
7424
|
+
* // Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project\}/instances/{instance\}`.
|
|
7392
7425
|
* parent: 'projects/my-project/instances/my-instance',
|
|
7393
7426
|
*
|
|
7394
7427
|
* // Request body metadata
|
|
@@ -7543,15 +7576,15 @@ export namespace spanner_v1 {
|
|
|
7543
7576
|
*
|
|
7544
7577
|
* // Do the magic
|
|
7545
7578
|
* const res = await spanner.projects.instances.backups.create({
|
|
7546
|
-
* // Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects
|
|
7579
|
+
* // 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\}`.
|
|
7547
7580
|
* backupId: 'placeholder-value',
|
|
7548
7581
|
* // Required. The encryption type of the backup.
|
|
7549
7582
|
* 'encryptionConfig.encryptionType': 'placeholder-value',
|
|
7550
|
-
* // 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
|
|
7583
|
+
* // 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\}`.
|
|
7551
7584
|
* 'encryptionConfig.kmsKeyName': 'placeholder-value',
|
|
7552
|
-
* // Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
7585
|
+
* // 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.
|
|
7553
7586
|
* 'encryptionConfig.kmsKeyNames': 'placeholder-value',
|
|
7554
|
-
* // 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
|
|
7587
|
+
* // 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\}`.
|
|
7555
7588
|
* parent: 'projects/my-project/instances/my-instance',
|
|
7556
7589
|
*
|
|
7557
7590
|
* // Request body metadata
|
|
@@ -7570,6 +7603,7 @@ export namespace spanner_v1 {
|
|
|
7570
7603
|
* // "incrementalBackupChainId": "my_incrementalBackupChainId",
|
|
7571
7604
|
* // "instancePartitions": [],
|
|
7572
7605
|
* // "maxExpireTime": "my_maxExpireTime",
|
|
7606
|
+
* // "minimumRestorableEdition": "my_minimumRestorableEdition",
|
|
7573
7607
|
* // "name": "my_name",
|
|
7574
7608
|
* // "oldestVersionTime": "my_oldestVersionTime",
|
|
7575
7609
|
* // "referencingBackups": [],
|
|
@@ -7721,7 +7755,7 @@ export namespace spanner_v1 {
|
|
|
7721
7755
|
*
|
|
7722
7756
|
* // Do the magic
|
|
7723
7757
|
* const res = await spanner.projects.instances.backups.delete({
|
|
7724
|
-
* // Required. Name of the backup to delete. Values are of the form `projects
|
|
7758
|
+
* // Required. Name of the backup to delete. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
7725
7759
|
* name: 'projects/my-project/instances/my-instance/backups/my-backup',
|
|
7726
7760
|
* });
|
|
7727
7761
|
* console.log(res.data);
|
|
@@ -7856,7 +7890,7 @@ export namespace spanner_v1 {
|
|
|
7856
7890
|
*
|
|
7857
7891
|
* // Do the magic
|
|
7858
7892
|
* const res = await spanner.projects.instances.backups.get({
|
|
7859
|
-
* // Required. Name of the backup. Values are of the form `projects
|
|
7893
|
+
* // Required. Name of the backup. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
7860
7894
|
* name: 'projects/my-project/instances/my-instance/backups/my-backup',
|
|
7861
7895
|
* });
|
|
7862
7896
|
* console.log(res.data);
|
|
@@ -7875,6 +7909,7 @@ export namespace spanner_v1 {
|
|
|
7875
7909
|
* // "incrementalBackupChainId": "my_incrementalBackupChainId",
|
|
7876
7910
|
* // "instancePartitions": [],
|
|
7877
7911
|
* // "maxExpireTime": "my_maxExpireTime",
|
|
7912
|
+
* // "minimumRestorableEdition": "my_minimumRestorableEdition",
|
|
7878
7913
|
* // "name": "my_name",
|
|
7879
7914
|
* // "oldestVersionTime": "my_oldestVersionTime",
|
|
7880
7915
|
* // "referencingBackups": [],
|
|
@@ -8167,7 +8202,7 @@ export namespace spanner_v1 {
|
|
|
8167
8202
|
* pageSize: 'placeholder-value',
|
|
8168
8203
|
* // If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`.
|
|
8169
8204
|
* pageToken: 'placeholder-value',
|
|
8170
|
-
* // Required. The instance to list backups from. Values are of the form `projects
|
|
8205
|
+
* // Required. The instance to list backups from. Values are of the form `projects/{project\}/instances/{instance\}`.
|
|
8171
8206
|
* parent: 'projects/my-project/instances/my-instance',
|
|
8172
8207
|
* });
|
|
8173
8208
|
* console.log(res.data);
|
|
@@ -8308,7 +8343,7 @@ export namespace spanner_v1 {
|
|
|
8308
8343
|
*
|
|
8309
8344
|
* // Do the magic
|
|
8310
8345
|
* const res = await spanner.projects.instances.backups.patch({
|
|
8311
|
-
* // 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
|
|
8346
|
+
* // 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\}`.
|
|
8312
8347
|
* name: 'projects/my-project/instances/my-instance/backups/my-backup',
|
|
8313
8348
|
* // 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.
|
|
8314
8349
|
* updateMask: 'placeholder-value',
|
|
@@ -8329,6 +8364,7 @@ export namespace spanner_v1 {
|
|
|
8329
8364
|
* // "incrementalBackupChainId": "my_incrementalBackupChainId",
|
|
8330
8365
|
* // "instancePartitions": [],
|
|
8331
8366
|
* // "maxExpireTime": "my_maxExpireTime",
|
|
8367
|
+
* // "minimumRestorableEdition": "my_minimumRestorableEdition",
|
|
8332
8368
|
* // "name": "my_name",
|
|
8333
8369
|
* // "oldestVersionTime": "my_oldestVersionTime",
|
|
8334
8370
|
* // "referencingBackups": [],
|
|
@@ -8355,6 +8391,7 @@ export namespace spanner_v1 {
|
|
|
8355
8391
|
* // "incrementalBackupChainId": "my_incrementalBackupChainId",
|
|
8356
8392
|
* // "instancePartitions": [],
|
|
8357
8393
|
* // "maxExpireTime": "my_maxExpireTime",
|
|
8394
|
+
* // "minimumRestorableEdition": "my_minimumRestorableEdition",
|
|
8358
8395
|
* // "name": "my_name",
|
|
8359
8396
|
* // "oldestVersionTime": "my_oldestVersionTime",
|
|
8360
8397
|
* // "referencingBackups": [],
|
|
@@ -8763,7 +8800,7 @@ export namespace spanner_v1 {
|
|
|
8763
8800
|
|
|
8764
8801
|
export interface Params$Resource$Projects$Instances$Backups$Copy extends StandardParameters {
|
|
8765
8802
|
/**
|
|
8766
|
-
* Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects
|
|
8803
|
+
* Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project\}/instances/{instance\}`.
|
|
8767
8804
|
*/
|
|
8768
8805
|
parent?: string;
|
|
8769
8806
|
|
|
@@ -8774,7 +8811,7 @@ export namespace spanner_v1 {
|
|
|
8774
8811
|
}
|
|
8775
8812
|
export interface Params$Resource$Projects$Instances$Backups$Create extends StandardParameters {
|
|
8776
8813
|
/**
|
|
8777
|
-
* Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects
|
|
8814
|
+
* 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\}`.
|
|
8778
8815
|
*/
|
|
8779
8816
|
backupId?: string;
|
|
8780
8817
|
/**
|
|
@@ -8782,15 +8819,15 @@ export namespace spanner_v1 {
|
|
|
8782
8819
|
*/
|
|
8783
8820
|
'encryptionConfig.encryptionType'?: string;
|
|
8784
8821
|
/**
|
|
8785
|
-
* 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
|
|
8822
|
+
* 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\}`.
|
|
8786
8823
|
*/
|
|
8787
8824
|
'encryptionConfig.kmsKeyName'?: string;
|
|
8788
8825
|
/**
|
|
8789
|
-
* Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
8826
|
+
* 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.
|
|
8790
8827
|
*/
|
|
8791
8828
|
'encryptionConfig.kmsKeyNames'?: string[];
|
|
8792
8829
|
/**
|
|
8793
|
-
* 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
|
|
8830
|
+
* 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\}`.
|
|
8794
8831
|
*/
|
|
8795
8832
|
parent?: string;
|
|
8796
8833
|
|
|
@@ -8801,13 +8838,13 @@ export namespace spanner_v1 {
|
|
|
8801
8838
|
}
|
|
8802
8839
|
export interface Params$Resource$Projects$Instances$Backups$Delete extends StandardParameters {
|
|
8803
8840
|
/**
|
|
8804
|
-
* Required. Name of the backup to delete. Values are of the form `projects
|
|
8841
|
+
* Required. Name of the backup to delete. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
8805
8842
|
*/
|
|
8806
8843
|
name?: string;
|
|
8807
8844
|
}
|
|
8808
8845
|
export interface Params$Resource$Projects$Instances$Backups$Get extends StandardParameters {
|
|
8809
8846
|
/**
|
|
8810
|
-
* Required. Name of the backup. Values are of the form `projects
|
|
8847
|
+
* Required. Name of the backup. Values are of the form `projects/{project\}/instances/{instance\}/backups/{backup\}`.
|
|
8811
8848
|
*/
|
|
8812
8849
|
name?: string;
|
|
8813
8850
|
}
|
|
@@ -8836,13 +8873,13 @@ export namespace spanner_v1 {
|
|
|
8836
8873
|
*/
|
|
8837
8874
|
pageToken?: string;
|
|
8838
8875
|
/**
|
|
8839
|
-
* Required. The instance to list backups from. Values are of the form `projects
|
|
8876
|
+
* Required. The instance to list backups from. Values are of the form `projects/{project\}/instances/{instance\}`.
|
|
8840
8877
|
*/
|
|
8841
8878
|
parent?: string;
|
|
8842
8879
|
}
|
|
8843
8880
|
export interface Params$Resource$Projects$Instances$Backups$Patch extends StandardParameters {
|
|
8844
8881
|
/**
|
|
8845
|
-
* 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
|
|
8882
|
+
* 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\}`.
|
|
8846
8883
|
*/
|
|
8847
8884
|
name?: string;
|
|
8848
8885
|
/**
|