@maxim_mazurok/gapi.client.spanner-v1 0.0.20250512 → 0.0.20250523
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 +24 -10
- 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: 20250523
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -43,7 +43,7 @@ declare namespace gapi.client {
|
|
|
43
43
|
stateUpdates?: {[P in string]: string};
|
|
44
44
|
}
|
|
45
45
|
interface AddSplitPointsRequest {
|
|
46
|
-
/** Optional. A user-supplied tag associated with the split points. For example, "initial_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else
|
|
46
|
+
/** Optional. A user-supplied tag associated with the split points. For example, "initial_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters, or else it is trimmed. Only valid UTF8 characters are allowed. */
|
|
47
47
|
initiator?: string;
|
|
48
48
|
/** Required. The split points to add. */
|
|
49
49
|
splitPoints?: SplitPoints[];
|
|
@@ -415,6 +415,12 @@ declare namespace gapi.client {
|
|
|
415
415
|
/** Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. */
|
|
416
416
|
versionRetentionPeriod?: string;
|
|
417
417
|
}
|
|
418
|
+
interface DatabaseMoveConfig {
|
|
419
|
+
/** Required. The unique identifier of the database resource in the Instance. For example if the database uri is projects/foo/instances/bar/databases/baz, the id to supply here is baz. */
|
|
420
|
+
databaseId?: string;
|
|
421
|
+
/** Optional. Encryption configuration to be used for the database in target configuration. Should be specified for every database which currently uses CMEK encryption. If a database currently uses GOOGLE_MANAGED encryption and a target encryption config is not specified, it defaults to GOOGLE_MANAGED. If a database currently uses Google-managed encryption and a target encryption config is specified, the request is rejected. If a database currently uses CMEK encryption, a target encryption config must be specified. You cannot move a CMEK database to a Google-managed encryption database by MoveInstance. */
|
|
422
|
+
encryptionConfig?: InstanceEncryptionConfig;
|
|
423
|
+
}
|
|
418
424
|
interface DatabaseRole {
|
|
419
425
|
/** Required. The name of the database role. Values are of the form `projects//instances//databases//databaseRoles/` where `` is as specified in the `CREATE ROLE` DDL statement. */
|
|
420
426
|
name?: string;
|
|
@@ -649,6 +655,12 @@ declare namespace gapi.client {
|
|
|
649
655
|
/** Output only. The storage limit in bytes per processing unit. */
|
|
650
656
|
storageLimitPerProcessingUnit?: string;
|
|
651
657
|
}
|
|
658
|
+
interface InstanceEncryptionConfig {
|
|
659
|
+
/** 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/`. */
|
|
660
|
+
kmsKeyName?: string;
|
|
661
|
+
/** 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. */
|
|
662
|
+
kmsKeyNames?: string[];
|
|
663
|
+
}
|
|
652
664
|
interface InstanceOperationProgress {
|
|
653
665
|
/** If set, the time at which this operation failed or was completed successfully. */
|
|
654
666
|
endTime?: string;
|
|
@@ -868,6 +880,8 @@ declare namespace gapi.client {
|
|
|
868
880
|
interface MoveInstanceRequest {
|
|
869
881
|
/** Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`. */
|
|
870
882
|
targetConfig?: string;
|
|
883
|
+
/** Optional. The configuration for each database in the target instance configuration. */
|
|
884
|
+
targetDatabaseMoveConfigs?: DatabaseMoveConfig[];
|
|
871
885
|
}
|
|
872
886
|
interface MultiplexedSessionPrecommitToken {
|
|
873
887
|
/** Opaque precommit token. */
|
|
@@ -1051,7 +1065,7 @@ declare namespace gapi.client {
|
|
|
1051
1065
|
maxStaleness?: string;
|
|
1052
1066
|
/** Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known. Note that this option can only be used in single-use transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */
|
|
1053
1067
|
minReadTimestamp?: string;
|
|
1054
|
-
/** Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read
|
|
1068
|
+
/** Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read is blocked until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */
|
|
1055
1069
|
readTimestamp?: string;
|
|
1056
1070
|
/** If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction. */
|
|
1057
1071
|
returnReadTimestamp?: boolean;
|
|
@@ -1243,7 +1257,7 @@ declare namespace gapi.client {
|
|
|
1243
1257
|
expireTime?: string;
|
|
1244
1258
|
/** The index to split. If specified, the `table` field must refer to the index's base table. */
|
|
1245
1259
|
index?: string;
|
|
1246
|
-
/** Required. The list of split keys,
|
|
1260
|
+
/** Required. The list of split keys. In essence, the split boundaries. */
|
|
1247
1261
|
keys?: Key[];
|
|
1248
1262
|
/** The table to split. */
|
|
1249
1263
|
table?: string;
|
|
@@ -1279,19 +1293,19 @@ declare namespace gapi.client {
|
|
|
1279
1293
|
interface Transaction {
|
|
1280
1294
|
/** `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests. */
|
|
1281
1295
|
id?: string;
|
|
1282
|
-
/** A precommit token
|
|
1296
|
+
/** A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */
|
|
1283
1297
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
1284
1298
|
/** For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */
|
|
1285
1299
|
readTimestamp?: string;
|
|
1286
1300
|
}
|
|
1287
1301
|
interface TransactionOptions {
|
|
1288
|
-
/** When `exclude_txn_from_change_streams` is set to `true
|
|
1302
|
+
/** When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams. * If the DDL option `allow_txn_exclusion` is set to `true`, then the updates made within this transaction aren't recorded in the change stream. * If you don't set the DDL option `allow_txn_exclusion` or if it's set to `false`, then the updates made within this transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The `exclude_txn_from_change_streams` option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an `INVALID_ARGUMENT` error. */
|
|
1289
1303
|
excludeTxnFromChangeStreams?: boolean;
|
|
1290
1304
|
/** Isolation level for the transaction. */
|
|
1291
1305
|
isolationLevel?: string;
|
|
1292
1306
|
/** Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */
|
|
1293
1307
|
partitionedDml?: any;
|
|
1294
|
-
/** Transaction
|
|
1308
|
+
/** Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. */
|
|
1295
1309
|
readOnly?: ReadOnly;
|
|
1296
1310
|
/** Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. */
|
|
1297
1311
|
readWrite?: ReadWrite;
|
|
@@ -3911,7 +3925,7 @@ declare namespace gapi.client {
|
|
|
3911
3925
|
): Request<PartialResultSet>;
|
|
3912
3926
|
}
|
|
3913
3927
|
interface DatabasesResource {
|
|
3914
|
-
/** Adds split points to specified tables
|
|
3928
|
+
/** Adds split points to specified tables and indexes of a database. */
|
|
3915
3929
|
addSplitPoints(request: {
|
|
3916
3930
|
/** V1 error format. */
|
|
3917
3931
|
'$.xgafv'?: string;
|
|
@@ -3921,7 +3935,7 @@ declare namespace gapi.client {
|
|
|
3921
3935
|
alt?: string;
|
|
3922
3936
|
/** JSONP */
|
|
3923
3937
|
callback?: string;
|
|
3924
|
-
/** Required. The database on whose tables
|
|
3938
|
+
/** Required. The database on whose tables or indexes the split points are to be added. Values are of the form `projects//instances//databases/`. */
|
|
3925
3939
|
database: string;
|
|
3926
3940
|
/** Selector specifying which fields to include in a partial response. */
|
|
3927
3941
|
fields?: string;
|
|
@@ -3950,7 +3964,7 @@ declare namespace gapi.client {
|
|
|
3950
3964
|
alt?: string;
|
|
3951
3965
|
/** JSONP */
|
|
3952
3966
|
callback?: string;
|
|
3953
|
-
/** Required. The database on whose tables
|
|
3967
|
+
/** Required. The database on whose tables or indexes the split points are to be added. Values are of the form `projects//instances//databases/`. */
|
|
3954
3968
|
database: string;
|
|
3955
3969
|
/** Selector specifying which fields to include in a partial response. */
|
|
3956
3970
|
fields?: string;
|