@maxim_mazurok/gapi.client.spanner-v1 0.0.20250123 → 0.0.20250128
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 +56 -50
- package/package.json +1 -1
- package/readme.md +2 -2
package/index.d.ts
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
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: 20250128
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
16
16
|
declare namespace gapi.client {
|
|
17
17
|
/** Load Cloud Spanner API v1 */
|
|
18
18
|
function load(
|
|
19
|
-
urlOrObject: 'https://spanner.googleapis.com/$discovery/rest?version=v1'
|
|
19
|
+
urlOrObject: 'https://spanner.googleapis.com/$discovery/rest?version=v1',
|
|
20
20
|
): Promise<void>;
|
|
21
21
|
/** @deprecated Please load APIs with discovery documents. */
|
|
22
22
|
function load(name: 'spanner', version: 'v1'): Promise<void>;
|
|
@@ -88,6 +88,8 @@ declare namespace gapi.client {
|
|
|
88
88
|
freeableSizeBytes?: string;
|
|
89
89
|
/** 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`. */
|
|
90
90
|
incrementalBackupChainId?: string;
|
|
91
|
+
/** 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`. */
|
|
92
|
+
instancePartitions?: BackupInstancePartition[];
|
|
91
93
|
/** 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`. */
|
|
92
94
|
maxExpireTime?: string;
|
|
93
95
|
/** 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//instances//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//instances/`. */
|
|
@@ -115,8 +117,12 @@ declare namespace gapi.client {
|
|
|
115
117
|
/** The backup contains an externally consistent copy of `source_database` at the timestamp specified by `version_time`. If the CreateBackup request did not specify `version_time`, the `version_time` of the backup is equivalent to the `create_time`. */
|
|
116
118
|
versionTime?: string;
|
|
117
119
|
}
|
|
120
|
+
interface BackupInstancePartition {
|
|
121
|
+
/** A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` */
|
|
122
|
+
instancePartition?: string;
|
|
123
|
+
}
|
|
118
124
|
interface BackupSchedule {
|
|
119
|
-
/** Optional. The encryption configuration that
|
|
125
|
+
/** Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. */
|
|
120
126
|
encryptionConfig?: CreateBackupEncryptionConfig;
|
|
121
127
|
/** The schedule creates only full backups. */
|
|
122
128
|
fullBackupSpec?: any;
|
|
@@ -356,11 +362,11 @@ declare namespace gapi.client {
|
|
|
356
362
|
session?: Session;
|
|
357
363
|
}
|
|
358
364
|
interface CrontabSpec {
|
|
359
|
-
/** Output only.
|
|
365
|
+
/** Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. */
|
|
360
366
|
creationWindow?: string;
|
|
361
|
-
/** Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. */
|
|
367
|
+
/** Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. */
|
|
362
368
|
text?: string;
|
|
363
|
-
/** Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. */
|
|
369
|
+
/** Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. */
|
|
364
370
|
timeZone?: string;
|
|
365
371
|
}
|
|
366
372
|
interface Database {
|
|
@@ -1731,7 +1737,7 @@ declare namespace gapi.client {
|
|
|
1731
1737
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1732
1738
|
uploadType?: string;
|
|
1733
1739
|
},
|
|
1734
|
-
body: CreateInstanceConfigRequest
|
|
1740
|
+
body: CreateInstanceConfigRequest,
|
|
1735
1741
|
): Request<Operation>;
|
|
1736
1742
|
/** Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. */
|
|
1737
1743
|
delete(request?: {
|
|
@@ -1878,7 +1884,7 @@ declare namespace gapi.client {
|
|
|
1878
1884
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1879
1885
|
uploadType?: string;
|
|
1880
1886
|
},
|
|
1881
|
-
body: UpdateInstanceConfigRequest
|
|
1887
|
+
body: UpdateInstanceConfigRequest,
|
|
1882
1888
|
): Request<Operation>;
|
|
1883
1889
|
operations: OperationsResource;
|
|
1884
1890
|
ssdCaches: SsdCachesResource;
|
|
@@ -2091,7 +2097,7 @@ declare namespace gapi.client {
|
|
|
2091
2097
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2092
2098
|
uploadType?: string;
|
|
2093
2099
|
},
|
|
2094
|
-
body: CopyBackupRequest
|
|
2100
|
+
body: CopyBackupRequest,
|
|
2095
2101
|
): Request<Operation>;
|
|
2096
2102
|
/** Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently. */
|
|
2097
2103
|
create(request: {
|
|
@@ -2165,7 +2171,7 @@ declare namespace gapi.client {
|
|
|
2165
2171
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2166
2172
|
uploadType?: string;
|
|
2167
2173
|
},
|
|
2168
|
-
body: Backup
|
|
2174
|
+
body: Backup,
|
|
2169
2175
|
): Request<Operation>;
|
|
2170
2176
|
/** Deletes a pending or completed Backup. */
|
|
2171
2177
|
delete(request?: {
|
|
@@ -2249,7 +2255,7 @@ declare namespace gapi.client {
|
|
|
2249
2255
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2250
2256
|
uploadType?: string;
|
|
2251
2257
|
},
|
|
2252
|
-
body: GetIamPolicyRequest
|
|
2258
|
+
body: GetIamPolicyRequest,
|
|
2253
2259
|
): Request<Policy>;
|
|
2254
2260
|
/** Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. */
|
|
2255
2261
|
list(request?: {
|
|
@@ -2344,7 +2350,7 @@ declare namespace gapi.client {
|
|
|
2344
2350
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2345
2351
|
uploadType?: string;
|
|
2346
2352
|
},
|
|
2347
|
-
body: Backup
|
|
2353
|
+
body: Backup,
|
|
2348
2354
|
): Request<Backup>;
|
|
2349
2355
|
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
2350
2356
|
setIamPolicy(
|
|
@@ -2374,7 +2380,7 @@ declare namespace gapi.client {
|
|
|
2374
2380
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2375
2381
|
uploadType?: string;
|
|
2376
2382
|
},
|
|
2377
|
-
body: SetIamPolicyRequest
|
|
2383
|
+
body: SetIamPolicyRequest,
|
|
2378
2384
|
): Request<Policy>;
|
|
2379
2385
|
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
2380
2386
|
testIamPermissions(
|
|
@@ -2404,7 +2410,7 @@ declare namespace gapi.client {
|
|
|
2404
2410
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2405
2411
|
uploadType?: string;
|
|
2406
2412
|
},
|
|
2407
|
-
body: TestIamPermissionsRequest
|
|
2413
|
+
body: TestIamPermissionsRequest,
|
|
2408
2414
|
): Request<TestIamPermissionsResponse>;
|
|
2409
2415
|
operations: OperationsResource;
|
|
2410
2416
|
}
|
|
@@ -2504,7 +2510,7 @@ declare namespace gapi.client {
|
|
|
2504
2510
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2505
2511
|
uploadType?: string;
|
|
2506
2512
|
},
|
|
2507
|
-
body: BackupSchedule
|
|
2513
|
+
body: BackupSchedule,
|
|
2508
2514
|
): Request<BackupSchedule>;
|
|
2509
2515
|
/** Deletes a backup schedule. */
|
|
2510
2516
|
delete(request?: {
|
|
@@ -2588,7 +2594,7 @@ declare namespace gapi.client {
|
|
|
2588
2594
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2589
2595
|
uploadType?: string;
|
|
2590
2596
|
},
|
|
2591
|
-
body: GetIamPolicyRequest
|
|
2597
|
+
body: GetIamPolicyRequest,
|
|
2592
2598
|
): Request<Policy>;
|
|
2593
2599
|
/** Lists all the backup schedules for the database. */
|
|
2594
2600
|
list(request?: {
|
|
@@ -2681,7 +2687,7 @@ declare namespace gapi.client {
|
|
|
2681
2687
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2682
2688
|
uploadType?: string;
|
|
2683
2689
|
},
|
|
2684
|
-
body: BackupSchedule
|
|
2690
|
+
body: BackupSchedule,
|
|
2685
2691
|
): Request<BackupSchedule>;
|
|
2686
2692
|
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
2687
2693
|
setIamPolicy(
|
|
@@ -2711,7 +2717,7 @@ declare namespace gapi.client {
|
|
|
2711
2717
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2712
2718
|
uploadType?: string;
|
|
2713
2719
|
},
|
|
2714
|
-
body: SetIamPolicyRequest
|
|
2720
|
+
body: SetIamPolicyRequest,
|
|
2715
2721
|
): Request<Policy>;
|
|
2716
2722
|
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
2717
2723
|
testIamPermissions(
|
|
@@ -2741,7 +2747,7 @@ declare namespace gapi.client {
|
|
|
2741
2747
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2742
2748
|
uploadType?: string;
|
|
2743
2749
|
},
|
|
2744
|
-
body: TestIamPermissionsRequest
|
|
2750
|
+
body: TestIamPermissionsRequest,
|
|
2745
2751
|
): Request<TestIamPermissionsResponse>;
|
|
2746
2752
|
}
|
|
2747
2753
|
interface DatabaseRolesResource {
|
|
@@ -2804,7 +2810,7 @@ declare namespace gapi.client {
|
|
|
2804
2810
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2805
2811
|
uploadType?: string;
|
|
2806
2812
|
},
|
|
2807
|
-
body: TestIamPermissionsRequest
|
|
2813
|
+
body: TestIamPermissionsRequest,
|
|
2808
2814
|
): Request<TestIamPermissionsResponse>;
|
|
2809
2815
|
}
|
|
2810
2816
|
interface OperationsResource {
|
|
@@ -2980,7 +2986,7 @@ declare namespace gapi.client {
|
|
|
2980
2986
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2981
2987
|
uploadType?: string;
|
|
2982
2988
|
},
|
|
2983
|
-
body: BatchCreateSessionsRequest
|
|
2989
|
+
body: BatchCreateSessionsRequest,
|
|
2984
2990
|
): Request<BatchCreateSessionsResponse>;
|
|
2985
2991
|
/** Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. */
|
|
2986
2992
|
batchWrite(request: {
|
|
@@ -3038,7 +3044,7 @@ declare namespace gapi.client {
|
|
|
3038
3044
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3039
3045
|
uploadType?: string;
|
|
3040
3046
|
},
|
|
3041
|
-
body: BatchWriteRequest
|
|
3047
|
+
body: BatchWriteRequest,
|
|
3042
3048
|
): Request<BatchWriteResponse>;
|
|
3043
3049
|
/** Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. */
|
|
3044
3050
|
beginTransaction(request: {
|
|
@@ -3096,7 +3102,7 @@ declare namespace gapi.client {
|
|
|
3096
3102
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3097
3103
|
uploadType?: string;
|
|
3098
3104
|
},
|
|
3099
|
-
body: BeginTransactionRequest
|
|
3105
|
+
body: BeginTransactionRequest,
|
|
3100
3106
|
): Request<Transaction>;
|
|
3101
3107
|
/** Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. */
|
|
3102
3108
|
commit(request: {
|
|
@@ -3154,7 +3160,7 @@ declare namespace gapi.client {
|
|
|
3154
3160
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3155
3161
|
uploadType?: string;
|
|
3156
3162
|
},
|
|
3157
|
-
body: CommitRequest
|
|
3163
|
+
body: CommitRequest,
|
|
3158
3164
|
): Request<CommitResponse>;
|
|
3159
3165
|
/** Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. */
|
|
3160
3166
|
create(request: {
|
|
@@ -3212,7 +3218,7 @@ declare namespace gapi.client {
|
|
|
3212
3218
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3213
3219
|
uploadType?: string;
|
|
3214
3220
|
},
|
|
3215
|
-
body: CreateSessionRequest
|
|
3221
|
+
body: CreateSessionRequest,
|
|
3216
3222
|
): Request<Session>;
|
|
3217
3223
|
/** Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. */
|
|
3218
3224
|
delete(request?: {
|
|
@@ -3297,7 +3303,7 @@ declare namespace gapi.client {
|
|
|
3297
3303
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3298
3304
|
uploadType?: string;
|
|
3299
3305
|
},
|
|
3300
|
-
body: ExecuteBatchDmlRequest
|
|
3306
|
+
body: ExecuteBatchDmlRequest,
|
|
3301
3307
|
): Request<ExecuteBatchDmlResponse>;
|
|
3302
3308
|
/** Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). */
|
|
3303
3309
|
executeSql(request: {
|
|
@@ -3355,7 +3361,7 @@ declare namespace gapi.client {
|
|
|
3355
3361
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3356
3362
|
uploadType?: string;
|
|
3357
3363
|
},
|
|
3358
|
-
body: ExecuteSqlRequest
|
|
3364
|
+
body: ExecuteSqlRequest,
|
|
3359
3365
|
): Request<ResultSet>;
|
|
3360
3366
|
/** Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). */
|
|
3361
3367
|
executeStreamingSql(request: {
|
|
@@ -3413,7 +3419,7 @@ declare namespace gapi.client {
|
|
|
3413
3419
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3414
3420
|
uploadType?: string;
|
|
3415
3421
|
},
|
|
3416
|
-
body: ExecuteSqlRequest
|
|
3422
|
+
body: ExecuteSqlRequest,
|
|
3417
3423
|
): Request<PartialResultSet>;
|
|
3418
3424
|
/** Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. */
|
|
3419
3425
|
get(request?: {
|
|
@@ -3531,7 +3537,7 @@ declare namespace gapi.client {
|
|
|
3531
3537
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3532
3538
|
uploadType?: string;
|
|
3533
3539
|
},
|
|
3534
|
-
body: PartitionQueryRequest
|
|
3540
|
+
body: PartitionQueryRequest,
|
|
3535
3541
|
): Request<PartitionResponse>;
|
|
3536
3542
|
/** Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. */
|
|
3537
3543
|
partitionRead(request: {
|
|
@@ -3589,7 +3595,7 @@ declare namespace gapi.client {
|
|
|
3589
3595
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3590
3596
|
uploadType?: string;
|
|
3591
3597
|
},
|
|
3592
|
-
body: PartitionReadRequest
|
|
3598
|
+
body: PartitionReadRequest,
|
|
3593
3599
|
): Request<PartitionResponse>;
|
|
3594
3600
|
/** Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. */
|
|
3595
3601
|
read(request: {
|
|
@@ -3647,7 +3653,7 @@ declare namespace gapi.client {
|
|
|
3647
3653
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3648
3654
|
uploadType?: string;
|
|
3649
3655
|
},
|
|
3650
|
-
body: ReadRequest
|
|
3656
|
+
body: ReadRequest,
|
|
3651
3657
|
): Request<ResultSet>;
|
|
3652
3658
|
/** Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. */
|
|
3653
3659
|
rollback(request: {
|
|
@@ -3705,7 +3711,7 @@ declare namespace gapi.client {
|
|
|
3705
3711
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3706
3712
|
uploadType?: string;
|
|
3707
3713
|
},
|
|
3708
|
-
body: RollbackRequest
|
|
3714
|
+
body: RollbackRequest,
|
|
3709
3715
|
): Request<{}>;
|
|
3710
3716
|
/** Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. */
|
|
3711
3717
|
streamingRead(request: {
|
|
@@ -3763,7 +3769,7 @@ declare namespace gapi.client {
|
|
|
3763
3769
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3764
3770
|
uploadType?: string;
|
|
3765
3771
|
},
|
|
3766
|
-
body: ReadRequest
|
|
3772
|
+
body: ReadRequest,
|
|
3767
3773
|
): Request<PartialResultSet>;
|
|
3768
3774
|
}
|
|
3769
3775
|
interface DatabasesResource {
|
|
@@ -3823,7 +3829,7 @@ declare namespace gapi.client {
|
|
|
3823
3829
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3824
3830
|
uploadType?: string;
|
|
3825
3831
|
},
|
|
3826
|
-
body: AddSplitPointsRequest
|
|
3832
|
+
body: AddSplitPointsRequest,
|
|
3827
3833
|
): Request<{}>;
|
|
3828
3834
|
/** `ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database. */
|
|
3829
3835
|
changequorum(request: {
|
|
@@ -3881,7 +3887,7 @@ declare namespace gapi.client {
|
|
|
3881
3887
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3882
3888
|
uploadType?: string;
|
|
3883
3889
|
},
|
|
3884
|
-
body: ChangeQuorumRequest
|
|
3890
|
+
body: ChangeQuorumRequest,
|
|
3885
3891
|
): Request<Operation>;
|
|
3886
3892
|
/** Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. */
|
|
3887
3893
|
create(request: {
|
|
@@ -3939,7 +3945,7 @@ declare namespace gapi.client {
|
|
|
3939
3945
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3940
3946
|
uploadType?: string;
|
|
3941
3947
|
},
|
|
3942
|
-
body: CreateDatabaseRequest
|
|
3948
|
+
body: CreateDatabaseRequest,
|
|
3943
3949
|
): Request<Operation>;
|
|
3944
3950
|
/** Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted. */
|
|
3945
3951
|
dropDatabase(request?: {
|
|
@@ -4050,7 +4056,7 @@ declare namespace gapi.client {
|
|
|
4050
4056
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4051
4057
|
uploadType?: string;
|
|
4052
4058
|
},
|
|
4053
|
-
body: GetIamPolicyRequest
|
|
4059
|
+
body: GetIamPolicyRequest,
|
|
4054
4060
|
): Request<Policy>;
|
|
4055
4061
|
/** Request a specific scan with Database-specific data for Cloud Key Visualizer. */
|
|
4056
4062
|
getScans(request?: {
|
|
@@ -4176,7 +4182,7 @@ declare namespace gapi.client {
|
|
|
4176
4182
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4177
4183
|
uploadType?: string;
|
|
4178
4184
|
},
|
|
4179
|
-
body: Database
|
|
4185
|
+
body: Database,
|
|
4180
4186
|
): Request<Operation>;
|
|
4181
4187
|
/** Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete. */
|
|
4182
4188
|
restore(request: {
|
|
@@ -4234,7 +4240,7 @@ declare namespace gapi.client {
|
|
|
4234
4240
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4235
4241
|
uploadType?: string;
|
|
4236
4242
|
},
|
|
4237
|
-
body: RestoreDatabaseRequest
|
|
4243
|
+
body: RestoreDatabaseRequest,
|
|
4238
4244
|
): Request<Operation>;
|
|
4239
4245
|
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
4240
4246
|
setIamPolicy(
|
|
@@ -4264,7 +4270,7 @@ declare namespace gapi.client {
|
|
|
4264
4270
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4265
4271
|
uploadType?: string;
|
|
4266
4272
|
},
|
|
4267
|
-
body: SetIamPolicyRequest
|
|
4273
|
+
body: SetIamPolicyRequest,
|
|
4268
4274
|
): Request<Policy>;
|
|
4269
4275
|
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
4270
4276
|
testIamPermissions(
|
|
@@ -4294,7 +4300,7 @@ declare namespace gapi.client {
|
|
|
4294
4300
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4295
4301
|
uploadType?: string;
|
|
4296
4302
|
},
|
|
4297
|
-
body: TestIamPermissionsRequest
|
|
4303
|
+
body: TestIamPermissionsRequest,
|
|
4298
4304
|
): Request<TestIamPermissionsResponse>;
|
|
4299
4305
|
/** 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. */
|
|
4300
4306
|
updateDdl(request: {
|
|
@@ -4352,7 +4358,7 @@ declare namespace gapi.client {
|
|
|
4352
4358
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4353
4359
|
uploadType?: string;
|
|
4354
4360
|
},
|
|
4355
|
-
body: UpdateDatabaseDdlRequest
|
|
4361
|
+
body: UpdateDatabaseDdlRequest,
|
|
4356
4362
|
): Request<Operation>;
|
|
4357
4363
|
backupSchedules: BackupSchedulesResource;
|
|
4358
4364
|
databaseRoles: DatabaseRolesResource;
|
|
@@ -4569,7 +4575,7 @@ declare namespace gapi.client {
|
|
|
4569
4575
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4570
4576
|
uploadType?: string;
|
|
4571
4577
|
},
|
|
4572
|
-
body: CreateInstancePartitionRequest
|
|
4578
|
+
body: CreateInstancePartitionRequest,
|
|
4573
4579
|
): Request<Operation>;
|
|
4574
4580
|
/** Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires `spanner.instancePartitions.delete` permission on the resource name. */
|
|
4575
4581
|
delete(request?: {
|
|
@@ -4716,7 +4722,7 @@ declare namespace gapi.client {
|
|
|
4716
4722
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4717
4723
|
uploadType?: string;
|
|
4718
4724
|
},
|
|
4719
|
-
body: UpdateInstancePartitionRequest
|
|
4725
|
+
body: UpdateInstancePartitionRequest,
|
|
4720
4726
|
): Request<Operation>;
|
|
4721
4727
|
operations: OperationsResource;
|
|
4722
4728
|
}
|
|
@@ -4893,7 +4899,7 @@ declare namespace gapi.client {
|
|
|
4893
4899
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4894
4900
|
uploadType?: string;
|
|
4895
4901
|
},
|
|
4896
|
-
body: CreateInstanceRequest
|
|
4902
|
+
body: CreateInstanceRequest,
|
|
4897
4903
|
): Request<Operation>;
|
|
4898
4904
|
/** Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted. */
|
|
4899
4905
|
delete(request?: {
|
|
@@ -4979,7 +4985,7 @@ declare namespace gapi.client {
|
|
|
4979
4985
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4980
4986
|
uploadType?: string;
|
|
4981
4987
|
},
|
|
4982
|
-
body: GetIamPolicyRequest
|
|
4988
|
+
body: GetIamPolicyRequest,
|
|
4983
4989
|
): Request<Policy>;
|
|
4984
4990
|
/** Lists all instances in the given project. */
|
|
4985
4991
|
list(request?: {
|
|
@@ -5072,7 +5078,7 @@ declare namespace gapi.client {
|
|
|
5072
5078
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5073
5079
|
uploadType?: string;
|
|
5074
5080
|
},
|
|
5075
|
-
body: MoveInstanceRequest
|
|
5081
|
+
body: MoveInstanceRequest,
|
|
5076
5082
|
): Request<Operation>;
|
|
5077
5083
|
/** Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name. */
|
|
5078
5084
|
patch(request: {
|
|
@@ -5130,7 +5136,7 @@ declare namespace gapi.client {
|
|
|
5130
5136
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5131
5137
|
uploadType?: string;
|
|
5132
5138
|
},
|
|
5133
|
-
body: UpdateInstanceRequest
|
|
5139
|
+
body: UpdateInstanceRequest,
|
|
5134
5140
|
): Request<Operation>;
|
|
5135
5141
|
/** Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource. */
|
|
5136
5142
|
setIamPolicy(
|
|
@@ -5160,7 +5166,7 @@ declare namespace gapi.client {
|
|
|
5160
5166
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5161
5167
|
uploadType?: string;
|
|
5162
5168
|
},
|
|
5163
|
-
body: SetIamPolicyRequest
|
|
5169
|
+
body: SetIamPolicyRequest,
|
|
5164
5170
|
): Request<Policy>;
|
|
5165
5171
|
/** Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions. */
|
|
5166
5172
|
testIamPermissions(
|
|
@@ -5190,7 +5196,7 @@ declare namespace gapi.client {
|
|
|
5190
5196
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5191
5197
|
uploadType?: string;
|
|
5192
5198
|
},
|
|
5193
|
-
body: TestIamPermissionsRequest
|
|
5199
|
+
body: TestIamPermissionsRequest,
|
|
5194
5200
|
): Request<TestIamPermissionsResponse>;
|
|
5195
5201
|
backupOperations: BackupOperationsResource;
|
|
5196
5202
|
backups: BackupsResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED