@maxim_mazurok/gapi.client.spanner-v1 0.2.20250920 → 0.3.20250920
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 +18 -22
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -37,8 +37,6 @@ 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;
|
|
42
40
|
/** Optional. Uninterpreted bytes from the underlying wire protocol. */
|
|
43
41
|
payload?: string;
|
|
44
42
|
/** Optional. Opaque state updates to be applied by the client. */
|
|
@@ -108,7 +106,7 @@ declare namespace gapi.client {
|
|
|
108
106
|
freeableSizeBytes?: string;
|
|
109
107
|
/** 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`. */
|
|
110
108
|
incrementalBackupChainId?: string;
|
|
111
|
-
/** Output only. The instance partition storing the backup. This is the same as the list of the instance
|
|
109
|
+
/** Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. */
|
|
112
110
|
instancePartitions?: BackupInstancePartition[];
|
|
113
111
|
/** 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`. */
|
|
114
112
|
maxExpireTime?: string;
|
|
@@ -272,8 +270,6 @@ declare namespace gapi.client {
|
|
|
272
270
|
commitTimestamp?: string;
|
|
273
271
|
/** If specified, transaction has not committed yet. You must retry the commit with the new precommit token. */
|
|
274
272
|
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;
|
|
277
273
|
}
|
|
278
274
|
interface CommitStats {
|
|
279
275
|
/** 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). */
|
|
@@ -292,7 +288,7 @@ declare namespace gapi.client {
|
|
|
292
288
|
interface CopyBackupEncryptionConfig {
|
|
293
289
|
/** Required. The encryption type of the backup. */
|
|
294
290
|
encryptionType?: string;
|
|
295
|
-
/** Optional.
|
|
291
|
+
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
296
292
|
kmsKeyName?: string;
|
|
297
293
|
/** 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. */
|
|
298
294
|
kmsKeyNames?: string[];
|
|
@@ -320,7 +316,7 @@ declare namespace gapi.client {
|
|
|
320
316
|
interface CreateBackupEncryptionConfig {
|
|
321
317
|
/** Required. The encryption type of the backup. */
|
|
322
318
|
encryptionType?: string;
|
|
323
|
-
/** Optional.
|
|
319
|
+
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
324
320
|
kmsKeyName?: string;
|
|
325
321
|
/** 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. */
|
|
326
322
|
kmsKeyNames?: string[];
|
|
@@ -480,11 +476,11 @@ declare namespace gapi.client {
|
|
|
480
476
|
valueCaptureType?: string;
|
|
481
477
|
}
|
|
482
478
|
interface DdlStatementActionInfo {
|
|
483
|
-
/** The action for the DDL statement,
|
|
479
|
+
/** The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string. */
|
|
484
480
|
action?: string;
|
|
485
|
-
/** The entity
|
|
481
|
+
/** The entity name(s) being operated on the DDL statement. E.g. 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` = []. */
|
|
486
482
|
entityNames?: string[];
|
|
487
|
-
/** The entity type for the DDL statement,
|
|
483
|
+
/** The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", `entity_type` = "". */
|
|
488
484
|
entityType?: string;
|
|
489
485
|
}
|
|
490
486
|
interface Delete {
|
|
@@ -714,7 +710,7 @@ declare namespace gapi.client {
|
|
|
714
710
|
storageLimitPerProcessingUnit?: string;
|
|
715
711
|
}
|
|
716
712
|
interface InstanceEncryptionConfig {
|
|
717
|
-
/** Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key.
|
|
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` should only be used if the location of the KMS key matches the database instance’s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
718
714
|
kmsKeyName?: string;
|
|
719
715
|
/** 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. */
|
|
720
716
|
kmsKeyNames?: string[];
|
|
@@ -752,7 +748,7 @@ declare namespace gapi.client {
|
|
|
752
748
|
updateTime?: string;
|
|
753
749
|
}
|
|
754
750
|
interface InstanceReplicaSelection {
|
|
755
|
-
/** Required. Name of the location of the replicas (
|
|
751
|
+
/** Required. Name of the location of the replicas (e.g., "us-central1"). */
|
|
756
752
|
location?: string;
|
|
757
753
|
}
|
|
758
754
|
interface Key {
|
|
@@ -1247,7 +1243,7 @@ declare namespace gapi.client {
|
|
|
1247
1243
|
interface RestoreDatabaseEncryptionConfig {
|
|
1248
1244
|
/** Required. The encryption type of the restored database. */
|
|
1249
1245
|
encryptionType?: string;
|
|
1250
|
-
/** Optional.
|
|
1246
|
+
/** Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
1251
1247
|
kmsKeyName?: string;
|
|
1252
1248
|
/** 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. */
|
|
1253
1249
|
kmsKeyNames?: string[];
|
|
@@ -1357,7 +1353,7 @@ declare namespace gapi.client {
|
|
|
1357
1353
|
subqueries?: {[P in string]: number};
|
|
1358
1354
|
}
|
|
1359
1355
|
interface SingleRegionQuorum {
|
|
1360
|
-
/** Required. The location of the serving region,
|
|
1356
|
+
/** Required. The location of the serving region, e.g. "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. */
|
|
1361
1357
|
servingLocation?: string;
|
|
1362
1358
|
}
|
|
1363
1359
|
interface SplitPoints {
|
|
@@ -1449,7 +1445,7 @@ declare namespace gapi.client {
|
|
|
1449
1445
|
progress?: OperationProgress[];
|
|
1450
1446
|
/** For an update this list contains all the statements. For an individual statement, this list contains only that statement. */
|
|
1451
1447
|
statements?: string[];
|
|
1452
|
-
/** Output only. When true, indicates that the operation is throttled
|
|
1448
|
+
/** Output only. When true, indicates that the operation is throttled e.g. due to resource constraints. When resources become available the operation will resume and this field will be false again. */
|
|
1453
1449
|
throttled?: boolean;
|
|
1454
1450
|
}
|
|
1455
1451
|
interface UpdateDatabaseDdlRequest {
|
|
@@ -2257,7 +2253,7 @@ declare namespace gapi.client {
|
|
|
2257
2253
|
callback?: string;
|
|
2258
2254
|
/** Required. The encryption type of the backup. */
|
|
2259
2255
|
'encryptionConfig.encryptionType'?: string;
|
|
2260
|
-
/** Optional.
|
|
2256
|
+
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
2261
2257
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2262
2258
|
/** 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. */
|
|
2263
2259
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
@@ -2267,7 +2263,7 @@ declare namespace gapi.client {
|
|
|
2267
2263
|
key?: string;
|
|
2268
2264
|
/** OAuth 2.0 token for the current user. */
|
|
2269
2265
|
oauth_token?: string;
|
|
2270
|
-
/** Required. The name of the instance in which the backup
|
|
2266
|
+
/** Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`. */
|
|
2271
2267
|
parent: string;
|
|
2272
2268
|
/** Returns response with indentations and line breaks. */
|
|
2273
2269
|
prettyPrint?: boolean;
|
|
@@ -2294,7 +2290,7 @@ declare namespace gapi.client {
|
|
|
2294
2290
|
callback?: string;
|
|
2295
2291
|
/** Required. The encryption type of the backup. */
|
|
2296
2292
|
'encryptionConfig.encryptionType'?: string;
|
|
2297
|
-
/** Optional.
|
|
2293
|
+
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
2298
2294
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2299
2295
|
/** 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. */
|
|
2300
2296
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
@@ -2304,7 +2300,7 @@ declare namespace gapi.client {
|
|
|
2304
2300
|
key?: string;
|
|
2305
2301
|
/** OAuth 2.0 token for the current user. */
|
|
2306
2302
|
oauth_token?: string;
|
|
2307
|
-
/** Required. The name of the instance in which the backup
|
|
2303
|
+
/** Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`. */
|
|
2308
2304
|
parent: string;
|
|
2309
2305
|
/** Returns response with indentations and line breaks. */
|
|
2310
2306
|
prettyPrint?: boolean;
|
|
@@ -2456,7 +2452,7 @@ declare namespace gapi.client {
|
|
|
2456
2452
|
prettyPrint?: boolean;
|
|
2457
2453
|
/** 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. */
|
|
2458
2454
|
quotaUser?: string;
|
|
2459
|
-
/** Required. A mask specifying which fields (
|
|
2455
|
+
/** Required. A mask specifying which fields (e.g. `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. */
|
|
2460
2456
|
updateMask?: string;
|
|
2461
2457
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2462
2458
|
upload_protocol?: string;
|
|
@@ -2487,7 +2483,7 @@ declare namespace gapi.client {
|
|
|
2487
2483
|
prettyPrint?: boolean;
|
|
2488
2484
|
/** 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. */
|
|
2489
2485
|
quotaUser?: string;
|
|
2490
|
-
/** Required. A mask specifying which fields (
|
|
2486
|
+
/** Required. A mask specifying which fields (e.g. `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. */
|
|
2491
2487
|
updateMask?: string;
|
|
2492
2488
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2493
2489
|
upload_protocol?: string;
|
|
@@ -4562,7 +4558,7 @@ declare namespace gapi.client {
|
|
|
4562
4558
|
},
|
|
4563
4559
|
body: TestIamPermissionsRequest,
|
|
4564
4560
|
): Request<TestIamPermissionsResponse>;
|
|
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
|
|
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 change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. */
|
|
4566
4562
|
updateDdl(request: {
|
|
4567
4563
|
/** V1 error format. */
|
|
4568
4564
|
'$.xgafv'?: string;
|