@maxim_mazurok/gapi.client.spanner-v1 0.38.20260218 → 0.38.20260622
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/index.d.ts +44 -34
- package/package.json +1 -1
- package/readme.md +12 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://spanner.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260622
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -108,7 +108,7 @@ declare namespace gapi.client {
|
|
|
108
108
|
backupSchedules?: string[];
|
|
109
109
|
/** Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. */
|
|
110
110
|
createTime?: string;
|
|
111
|
-
/** 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
|
|
111
|
+
/** 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}`. */
|
|
112
112
|
database?: string;
|
|
113
113
|
/** Output only. The database dialect information for the backup. */
|
|
114
114
|
databaseDialect?:
|
|
@@ -137,13 +137,13 @@ declare namespace gapi.client {
|
|
|
137
137
|
| 'STANDARD'
|
|
138
138
|
| 'ENTERPRISE'
|
|
139
139
|
| 'ENTERPRISE_PLUS';
|
|
140
|
-
/** 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
|
|
140
|
+
/** 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}`. */
|
|
141
141
|
name?: string;
|
|
142
142
|
/** Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. */
|
|
143
143
|
oldestVersionTime?: string;
|
|
144
|
-
/** Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects
|
|
144
|
+
/** 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. */
|
|
145
145
|
referencingBackups?: string[];
|
|
146
|
-
/** Output only. The names of the restored databases that reference the backup. The database names are of the form `projects
|
|
146
|
+
/** 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. */
|
|
147
147
|
referencingDatabases?: string[];
|
|
148
148
|
/** Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. */
|
|
149
149
|
sizeBytes?: string;
|
|
@@ -163,7 +163,7 @@ declare namespace gapi.client {
|
|
|
163
163
|
versionTime?: string;
|
|
164
164
|
}
|
|
165
165
|
interface BackupInstancePartition {
|
|
166
|
-
/** A unique identifier for the instance partition. Values are of the form `projects
|
|
166
|
+
/** A unique identifier for the instance partition. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition_id}` */
|
|
167
167
|
instancePartition?: string;
|
|
168
168
|
}
|
|
169
169
|
interface BackupSchedule {
|
|
@@ -299,8 +299,18 @@ declare namespace gapi.client {
|
|
|
299
299
|
commitStats?: CommitStats;
|
|
300
300
|
/** The Cloud Spanner timestamp at which the transaction committed. */
|
|
301
301
|
commitTimestamp?: string;
|
|
302
|
+
/** The isolation level used for the read-write transaction. */
|
|
303
|
+
isolationLevel?:
|
|
304
|
+
| 'ISOLATION_LEVEL_UNSPECIFIED'
|
|
305
|
+
| 'SERIALIZABLE'
|
|
306
|
+
| 'REPEATABLE_READ';
|
|
302
307
|
/** If specified, transaction has not committed yet. You must retry the commit with the new precommit token. */
|
|
303
308
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
309
|
+
/** The read lock mode used for the read-write transaction. */
|
|
310
|
+
readLockMode?:
|
|
311
|
+
| 'READ_LOCK_MODE_UNSPECIFIED'
|
|
312
|
+
| 'PESSIMISTIC'
|
|
313
|
+
| 'OPTIMISTIC';
|
|
304
314
|
/** If `TransactionOptions.isolation_level` is set to `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the timestamp at which all reads in the transaction ran. This timestamp is never returned. */
|
|
305
315
|
snapshotTimestamp?: string;
|
|
306
316
|
}
|
|
@@ -338,29 +348,29 @@ declare namespace gapi.client {
|
|
|
338
348
|
| 'USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION'
|
|
339
349
|
| 'GOOGLE_DEFAULT_ENCRYPTION'
|
|
340
350
|
| 'CUSTOMER_MANAGED_ENCRYPTION';
|
|
341
|
-
/** 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
|
|
351
|
+
/** 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}`. */
|
|
342
352
|
kmsKeyName?: string;
|
|
343
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
353
|
+
/** 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. */
|
|
344
354
|
kmsKeyNames?: string[];
|
|
345
355
|
}
|
|
346
356
|
interface CopyBackupMetadata {
|
|
347
357
|
/** The time at which cancellation of CopyBackup operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
|
|
348
358
|
cancelTime?: string;
|
|
349
|
-
/** The name of the backup being created through the copy operation. Values are of the form `projects
|
|
359
|
+
/** The name of the backup being created through the copy operation. Values are of the form `projects/{project}/instances/{instance}/backups/{backup}`. */
|
|
350
360
|
name?: string;
|
|
351
361
|
/** The progress of the CopyBackup operation. */
|
|
352
362
|
progress?: OperationProgress;
|
|
353
|
-
/** The name of the source backup that is being copied. Values are of the form `projects
|
|
363
|
+
/** The name of the source backup that is being copied. Values are of the form `projects/{project}/instances/{instance}/backups/{backup}`. */
|
|
354
364
|
sourceBackup?: string;
|
|
355
365
|
}
|
|
356
366
|
interface CopyBackupRequest {
|
|
357
|
-
/** Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects
|
|
367
|
+
/** 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}`. */
|
|
358
368
|
backupId?: string;
|
|
359
369
|
/** Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. */
|
|
360
370
|
encryptionConfig?: CopyBackupEncryptionConfig;
|
|
361
371
|
/** Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. */
|
|
362
372
|
expireTime?: string;
|
|
363
|
-
/** 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
|
|
373
|
+
/** 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}`. */
|
|
364
374
|
sourceBackup?: string;
|
|
365
375
|
}
|
|
366
376
|
interface CreateBackupEncryptionConfig {
|
|
@@ -370,9 +380,9 @@ declare namespace gapi.client {
|
|
|
370
380
|
| 'USE_DATABASE_ENCRYPTION'
|
|
371
381
|
| 'GOOGLE_DEFAULT_ENCRYPTION'
|
|
372
382
|
| 'CUSTOMER_MANAGED_ENCRYPTION';
|
|
373
|
-
/** 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
|
|
383
|
+
/** 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}`. */
|
|
374
384
|
kmsKeyName?: string;
|
|
375
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
385
|
+
/** 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. */
|
|
376
386
|
kmsKeyNames?: string[];
|
|
377
387
|
}
|
|
378
388
|
interface CreateBackupMetadata {
|
|
@@ -839,9 +849,9 @@ declare namespace gapi.client {
|
|
|
839
849
|
etag?: string;
|
|
840
850
|
/** Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. */
|
|
841
851
|
name?: string;
|
|
842
|
-
/** The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. */
|
|
852
|
+
/** The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. */
|
|
843
853
|
nodeCount?: number;
|
|
844
|
-
/** The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. */
|
|
854
|
+
/** The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. */
|
|
845
855
|
processingUnits?: number;
|
|
846
856
|
/** Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. */
|
|
847
857
|
referencingBackups?: string[];
|
|
@@ -1324,7 +1334,7 @@ declare namespace gapi.client {
|
|
|
1324
1334
|
interface ReadWrite {
|
|
1325
1335
|
/** Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. */
|
|
1326
1336
|
multiplexedSessionPreviousTransactionId?: string;
|
|
1327
|
-
/**
|
|
1337
|
+
/** The read lock mode for the transaction. */
|
|
1328
1338
|
readLockMode?:
|
|
1329
1339
|
| 'READ_LOCK_MODE_UNSPECIFIED'
|
|
1330
1340
|
| 'PESSIMISTIC'
|
|
@@ -1518,7 +1528,7 @@ declare namespace gapi.client {
|
|
|
1518
1528
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1519
1529
|
code?: number;
|
|
1520
1530
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1521
|
-
details?:
|
|
1531
|
+
details?: {[P in string]: any}[];
|
|
1522
1532
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
1523
1533
|
message?: string;
|
|
1524
1534
|
}
|
|
@@ -2223,7 +2233,7 @@ declare namespace gapi.client {
|
|
|
2223
2233
|
pageSize?: number;
|
|
2224
2234
|
/** If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`. */
|
|
2225
2235
|
pageToken?: string;
|
|
2226
|
-
/** Required. The instance of the backup operations. Values are of the form `projects
|
|
2236
|
+
/** Required. The instance of the backup operations. Values are of the form `projects/{project}/instances/{instance}`. */
|
|
2227
2237
|
parent: string;
|
|
2228
2238
|
/** Returns response with indentations and line breaks. */
|
|
2229
2239
|
prettyPrint?: boolean;
|
|
@@ -2370,7 +2380,7 @@ declare namespace gapi.client {
|
|
|
2370
2380
|
key?: string;
|
|
2371
2381
|
/** OAuth 2.0 token for the current user. */
|
|
2372
2382
|
oauth_token?: string;
|
|
2373
|
-
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects
|
|
2383
|
+
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project}/instances/{instance}`. */
|
|
2374
2384
|
parent: string;
|
|
2375
2385
|
/** Returns response with indentations and line breaks. */
|
|
2376
2386
|
prettyPrint?: boolean;
|
|
@@ -2399,7 +2409,7 @@ declare namespace gapi.client {
|
|
|
2399
2409
|
key?: string;
|
|
2400
2410
|
/** OAuth 2.0 token for the current user. */
|
|
2401
2411
|
oauth_token?: string;
|
|
2402
|
-
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects
|
|
2412
|
+
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/{project}/instances/{instance}`. */
|
|
2403
2413
|
parent: string;
|
|
2404
2414
|
/** Returns response with indentations and line breaks. */
|
|
2405
2415
|
prettyPrint?: boolean;
|
|
@@ -2420,7 +2430,7 @@ declare namespace gapi.client {
|
|
|
2420
2430
|
access_token?: string;
|
|
2421
2431
|
/** Data format for response. */
|
|
2422
2432
|
alt?: 'json' | 'media' | 'proto';
|
|
2423
|
-
/** Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects
|
|
2433
|
+
/** 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}`. */
|
|
2424
2434
|
backupId?: string;
|
|
2425
2435
|
/** JSONP */
|
|
2426
2436
|
callback?: string;
|
|
@@ -2430,9 +2440,9 @@ declare namespace gapi.client {
|
|
|
2430
2440
|
| 'USE_DATABASE_ENCRYPTION'
|
|
2431
2441
|
| 'GOOGLE_DEFAULT_ENCRYPTION'
|
|
2432
2442
|
| 'CUSTOMER_MANAGED_ENCRYPTION';
|
|
2433
|
-
/** 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
|
|
2443
|
+
/** 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}`. */
|
|
2434
2444
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2435
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
2445
|
+
/** 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. */
|
|
2436
2446
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
2437
2447
|
/** Selector specifying which fields to include in a partial response. */
|
|
2438
2448
|
fields?: string;
|
|
@@ -2440,7 +2450,7 @@ declare namespace gapi.client {
|
|
|
2440
2450
|
key?: string;
|
|
2441
2451
|
/** OAuth 2.0 token for the current user. */
|
|
2442
2452
|
oauth_token?: string;
|
|
2443
|
-
/** 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
|
|
2453
|
+
/** 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}`. */
|
|
2444
2454
|
parent: string;
|
|
2445
2455
|
/** Returns response with indentations and line breaks. */
|
|
2446
2456
|
prettyPrint?: boolean;
|
|
@@ -2461,7 +2471,7 @@ declare namespace gapi.client {
|
|
|
2461
2471
|
access_token?: string;
|
|
2462
2472
|
/** Data format for response. */
|
|
2463
2473
|
alt?: 'json' | 'media' | 'proto';
|
|
2464
|
-
/** Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects
|
|
2474
|
+
/** 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}`. */
|
|
2465
2475
|
backupId?: string;
|
|
2466
2476
|
/** JSONP */
|
|
2467
2477
|
callback?: string;
|
|
@@ -2471,9 +2481,9 @@ declare namespace gapi.client {
|
|
|
2471
2481
|
| 'USE_DATABASE_ENCRYPTION'
|
|
2472
2482
|
| 'GOOGLE_DEFAULT_ENCRYPTION'
|
|
2473
2483
|
| 'CUSTOMER_MANAGED_ENCRYPTION';
|
|
2474
|
-
/** 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
|
|
2484
|
+
/** 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}`. */
|
|
2475
2485
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2476
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects
|
|
2486
|
+
/** 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. */
|
|
2477
2487
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
2478
2488
|
/** Selector specifying which fields to include in a partial response. */
|
|
2479
2489
|
fields?: string;
|
|
@@ -2481,7 +2491,7 @@ declare namespace gapi.client {
|
|
|
2481
2491
|
key?: string;
|
|
2482
2492
|
/** OAuth 2.0 token for the current user. */
|
|
2483
2493
|
oauth_token?: string;
|
|
2484
|
-
/** 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
|
|
2494
|
+
/** 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}`. */
|
|
2485
2495
|
parent: string;
|
|
2486
2496
|
/** Returns response with indentations and line breaks. */
|
|
2487
2497
|
prettyPrint?: boolean;
|
|
@@ -2508,7 +2518,7 @@ declare namespace gapi.client {
|
|
|
2508
2518
|
fields?: string;
|
|
2509
2519
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2510
2520
|
key?: string;
|
|
2511
|
-
/** Required. Name of the backup to delete. Values are of the form `projects
|
|
2521
|
+
/** Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/backups/{backup}`. */
|
|
2512
2522
|
name: string;
|
|
2513
2523
|
/** OAuth 2.0 token for the current user. */
|
|
2514
2524
|
oauth_token?: string;
|
|
@@ -2535,7 +2545,7 @@ declare namespace gapi.client {
|
|
|
2535
2545
|
fields?: string;
|
|
2536
2546
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2537
2547
|
key?: string;
|
|
2538
|
-
/** Required. Name of the backup. Values are of the form `projects
|
|
2548
|
+
/** Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/backups/{backup}`. */
|
|
2539
2549
|
name: string;
|
|
2540
2550
|
/** OAuth 2.0 token for the current user. */
|
|
2541
2551
|
oauth_token?: string;
|
|
@@ -2600,7 +2610,7 @@ declare namespace gapi.client {
|
|
|
2600
2610
|
pageSize?: number;
|
|
2601
2611
|
/** If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`. */
|
|
2602
2612
|
pageToken?: string;
|
|
2603
|
-
/** Required. The instance to list backups from. Values are of the form `projects
|
|
2613
|
+
/** Required. The instance to list backups from. Values are of the form `projects/{project}/instances/{instance}`. */
|
|
2604
2614
|
parent: string;
|
|
2605
2615
|
/** Returns response with indentations and line breaks. */
|
|
2606
2616
|
prettyPrint?: boolean;
|
|
@@ -2625,7 +2635,7 @@ declare namespace gapi.client {
|
|
|
2625
2635
|
fields?: string;
|
|
2626
2636
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2627
2637
|
key?: string;
|
|
2628
|
-
/** 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
|
|
2638
|
+
/** 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}`. */
|
|
2629
2639
|
name: string;
|
|
2630
2640
|
/** OAuth 2.0 token for the current user. */
|
|
2631
2641
|
oauth_token?: string;
|
|
@@ -2656,7 +2666,7 @@ declare namespace gapi.client {
|
|
|
2656
2666
|
fields?: string;
|
|
2657
2667
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2658
2668
|
key?: string;
|
|
2659
|
-
/** 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
|
|
2669
|
+
/** 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}`. */
|
|
2660
2670
|
name: string;
|
|
2661
2671
|
/** OAuth 2.0 token for the current user. */
|
|
2662
2672
|
oauth_token?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,18 @@ Install typings for Cloud Spanner API:
|
|
|
11
11
|
npm install @types/gapi.client.spanner-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.spanner-v1"]
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
14
26
|
## Usage
|
|
15
27
|
|
|
16
28
|
You need to initialize Google API client in your code:
|