@maxim_mazurok/gapi.client.spanner-v1 0.37.20250920 → 0.37.20251014
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 +23 -19
- package/package.json +1 -1
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: 20251014
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -37,6 +37,8 @@ declare namespace gapi.client {
|
|
|
37
37
|
protocol?: string;
|
|
38
38
|
}
|
|
39
39
|
interface AdaptMessageResponse {
|
|
40
|
+
/** Optional. Indicates whether this is the last AdaptMessageResponse in the stream. This field may be optionally set by the server. Clients should not rely on this field being set in all cases. */
|
|
41
|
+
last?: boolean;
|
|
40
42
|
/** Optional. Uninterpreted bytes from the underlying wire protocol. */
|
|
41
43
|
payload?: string;
|
|
42
44
|
/** Optional. Opaque state updates to be applied by the client. */
|
|
@@ -106,7 +108,7 @@ declare namespace gapi.client {
|
|
|
106
108
|
freeableSizeBytes?: string;
|
|
107
109
|
/** Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. */
|
|
108
110
|
incrementalBackupChainId?: string;
|
|
109
|
-
/** Output only. The instance partition
|
|
111
|
+
/** Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. */
|
|
110
112
|
instancePartitions?: BackupInstancePartition[];
|
|
111
113
|
/** Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. */
|
|
112
114
|
maxExpireTime?: string;
|
|
@@ -270,6 +272,8 @@ declare namespace gapi.client {
|
|
|
270
272
|
commitTimestamp?: string;
|
|
271
273
|
/** If specified, transaction has not committed yet. You must retry the commit with the new precommit token. */
|
|
272
274
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
275
|
+
/** 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. */
|
|
276
|
+
snapshotTimestamp?: string;
|
|
273
277
|
}
|
|
274
278
|
interface CommitStats {
|
|
275
279
|
/** The total number of mutations for the transaction. Knowing the `mutation_count` value can help you maximize the number of mutations in a transaction and minimize the number of API round trips. You can also monitor this value to prevent transactions from exceeding the system [limit](https://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data). If the number of mutations exceeds the limit, the server returns [INVALID_ARGUMENT](https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT). */
|
|
@@ -288,7 +292,7 @@ declare namespace gapi.client {
|
|
|
288
292
|
interface CopyBackupEncryptionConfig {
|
|
289
293
|
/** Required. The encryption type of the backup. */
|
|
290
294
|
encryptionType?: string;
|
|
291
|
-
/** Optional. The Cloud KMS key that
|
|
295
|
+
/** 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/`. */
|
|
292
296
|
kmsKeyName?: string;
|
|
293
297
|
/** 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. */
|
|
294
298
|
kmsKeyNames?: string[];
|
|
@@ -316,7 +320,7 @@ declare namespace gapi.client {
|
|
|
316
320
|
interface CreateBackupEncryptionConfig {
|
|
317
321
|
/** Required. The encryption type of the backup. */
|
|
318
322
|
encryptionType?: string;
|
|
319
|
-
/** Optional. The Cloud KMS key that
|
|
323
|
+
/** 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/`. */
|
|
320
324
|
kmsKeyName?: string;
|
|
321
325
|
/** 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. */
|
|
322
326
|
kmsKeyNames?: string[];
|
|
@@ -476,11 +480,11 @@ declare namespace gapi.client {
|
|
|
476
480
|
valueCaptureType?: string;
|
|
477
481
|
}
|
|
478
482
|
interface DdlStatementActionInfo {
|
|
479
|
-
/** The action for the DDL statement,
|
|
483
|
+
/** The action for the DDL statement, for example, CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string. */
|
|
480
484
|
action?: string;
|
|
481
|
-
/** The entity
|
|
485
|
+
/** The entity names being operated on the DDL statement. For example, 1. For statement "CREATE TABLE t1(...)", `entity_names` = ["t1"]. 2. For statement "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"]. 3. For statement "ANALYZE", `entity_names` = []. */
|
|
482
486
|
entityNames?: string[];
|
|
483
|
-
/** The entity type for the DDL statement,
|
|
487
|
+
/** The entity type for the DDL statement, for example, TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, for example, for statement "ANALYZE", `entity_type` = "". */
|
|
484
488
|
entityType?: string;
|
|
485
489
|
}
|
|
486
490
|
interface Delete {
|
|
@@ -710,7 +714,7 @@ declare namespace gapi.client {
|
|
|
710
714
|
storageLimitPerProcessingUnit?: string;
|
|
711
715
|
}
|
|
712
716
|
interface InstanceEncryptionConfig {
|
|
713
|
-
/** Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name`
|
|
717
|
+
/** 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. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
714
718
|
kmsKeyName?: string;
|
|
715
719
|
/** Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database'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. */
|
|
716
720
|
kmsKeyNames?: string[];
|
|
@@ -748,7 +752,7 @@ declare namespace gapi.client {
|
|
|
748
752
|
updateTime?: string;
|
|
749
753
|
}
|
|
750
754
|
interface InstanceReplicaSelection {
|
|
751
|
-
/** Required. Name of the location of the replicas (
|
|
755
|
+
/** Required. Name of the location of the replicas (for example, "us-central1"). */
|
|
752
756
|
location?: string;
|
|
753
757
|
}
|
|
754
758
|
interface Key {
|
|
@@ -1243,7 +1247,7 @@ declare namespace gapi.client {
|
|
|
1243
1247
|
interface RestoreDatabaseEncryptionConfig {
|
|
1244
1248
|
/** Required. The encryption type of the restored database. */
|
|
1245
1249
|
encryptionType?: string;
|
|
1246
|
-
/** Optional. The Cloud KMS key that
|
|
1250
|
+
/** 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/`. */
|
|
1247
1251
|
kmsKeyName?: string;
|
|
1248
1252
|
/** Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database'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. */
|
|
1249
1253
|
kmsKeyNames?: string[];
|
|
@@ -1353,7 +1357,7 @@ declare namespace gapi.client {
|
|
|
1353
1357
|
subqueries?: {[P in string]: number};
|
|
1354
1358
|
}
|
|
1355
1359
|
interface SingleRegionQuorum {
|
|
1356
|
-
/** Required. The location of the serving region,
|
|
1360
|
+
/** Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. */
|
|
1357
1361
|
servingLocation?: string;
|
|
1358
1362
|
}
|
|
1359
1363
|
interface SplitPoints {
|
|
@@ -1445,7 +1449,7 @@ declare namespace gapi.client {
|
|
|
1445
1449
|
progress?: OperationProgress[];
|
|
1446
1450
|
/** For an update this list contains all the statements. For an individual statement, this list contains only that statement. */
|
|
1447
1451
|
statements?: string[];
|
|
1448
|
-
/** Output only. When true, indicates that the operation is throttled
|
|
1452
|
+
/** Output only. When true, indicates that the operation is throttled, for example, due to resource constraints. When resources become available the operation will resume and this field will be false again. */
|
|
1449
1453
|
throttled?: boolean;
|
|
1450
1454
|
}
|
|
1451
1455
|
interface UpdateDatabaseDdlRequest {
|
|
@@ -2253,7 +2257,7 @@ declare namespace gapi.client {
|
|
|
2253
2257
|
callback?: string;
|
|
2254
2258
|
/** Required. The encryption type of the backup. */
|
|
2255
2259
|
'encryptionConfig.encryptionType'?: string;
|
|
2256
|
-
/** Optional. The Cloud KMS key that
|
|
2260
|
+
/** 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/`. */
|
|
2257
2261
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2258
2262
|
/** 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. */
|
|
2259
2263
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
@@ -2263,7 +2267,7 @@ declare namespace gapi.client {
|
|
|
2263
2267
|
key?: string;
|
|
2264
2268
|
/** OAuth 2.0 token for the current user. */
|
|
2265
2269
|
oauth_token?: string;
|
|
2266
|
-
/** Required. The name of the instance in which the backup
|
|
2270
|
+
/** 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/`. */
|
|
2267
2271
|
parent: string;
|
|
2268
2272
|
/** Returns response with indentations and line breaks. */
|
|
2269
2273
|
prettyPrint?: boolean;
|
|
@@ -2290,7 +2294,7 @@ declare namespace gapi.client {
|
|
|
2290
2294
|
callback?: string;
|
|
2291
2295
|
/** Required. The encryption type of the backup. */
|
|
2292
2296
|
'encryptionConfig.encryptionType'?: string;
|
|
2293
|
-
/** Optional. The Cloud KMS key that
|
|
2297
|
+
/** 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/`. */
|
|
2294
2298
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2295
2299
|
/** 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. */
|
|
2296
2300
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
@@ -2300,7 +2304,7 @@ declare namespace gapi.client {
|
|
|
2300
2304
|
key?: string;
|
|
2301
2305
|
/** OAuth 2.0 token for the current user. */
|
|
2302
2306
|
oauth_token?: string;
|
|
2303
|
-
/** Required. The name of the instance in which the backup
|
|
2307
|
+
/** 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/`. */
|
|
2304
2308
|
parent: string;
|
|
2305
2309
|
/** Returns response with indentations and line breaks. */
|
|
2306
2310
|
prettyPrint?: boolean;
|
|
@@ -2452,7 +2456,7 @@ declare namespace gapi.client {
|
|
|
2452
2456
|
prettyPrint?: boolean;
|
|
2453
2457
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2454
2458
|
quotaUser?: string;
|
|
2455
|
-
/** Required. A mask specifying which fields (
|
|
2459
|
+
/** 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. */
|
|
2456
2460
|
updateMask?: string;
|
|
2457
2461
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2458
2462
|
upload_protocol?: string;
|
|
@@ -2483,7 +2487,7 @@ declare namespace gapi.client {
|
|
|
2483
2487
|
prettyPrint?: boolean;
|
|
2484
2488
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2485
2489
|
quotaUser?: string;
|
|
2486
|
-
/** Required. A mask specifying which fields (
|
|
2490
|
+
/** 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. */
|
|
2487
2491
|
updateMask?: string;
|
|
2488
2492
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2489
2493
|
upload_protocol?: string;
|
|
@@ -4558,7 +4562,7 @@ declare namespace gapi.client {
|
|
|
4558
4562
|
},
|
|
4559
4563
|
body: TestIamPermissionsRequest,
|
|
4560
4564
|
): Request<TestIamPermissionsResponse>;
|
|
4561
|
-
/** Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema
|
|
4565
|
+
/** Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. */
|
|
4562
4566
|
updateDdl(request: {
|
|
4563
4567
|
/** V1 error format. */
|
|
4564
4568
|
'$.xgafv'?: string;
|