@maxim_mazurok/gapi.client.spanner-v1 0.0.20220726
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 +4234 -0
- package/package.json +20 -0
- package/readme.md +79 -0
- package/tests.ts +1332 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,4234 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Cloud Spanner API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/spanner/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://spanner.googleapis.com/$discovery/rest?version=v1
|
|
13
|
+
// Revision: 20220726
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Cloud Spanner API v1 */
|
|
19
|
+
function load(urlOrObject: "https://spanner.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "spanner", version: "v1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "spanner", version: "v1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace spanner {
|
|
26
|
+
interface Backup {
|
|
27
|
+
/** Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. */
|
|
28
|
+
createTime?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form
|
|
31
|
+
* `projects//instances//databases/`.
|
|
32
|
+
*/
|
|
33
|
+
database?: string;
|
|
34
|
+
/** Output only. The database dialect information for the backup. */
|
|
35
|
+
databaseDialect?: string;
|
|
36
|
+
/** Output only. The encryption information for the backup. */
|
|
37
|
+
encryptionInfo?: EncryptionInfo;
|
|
38
|
+
/**
|
|
39
|
+
* Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the
|
|
40
|
+
* CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
|
|
41
|
+
*/
|
|
42
|
+
expireTime?: string;
|
|
43
|
+
/**
|
|
44
|
+
* 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,
|
|
45
|
+
* CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.
|
|
46
|
+
*/
|
|
47
|
+
maxExpireTime?: string;
|
|
48
|
+
/**
|
|
49
|
+
* 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
|
|
50
|
+
* `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
|
|
51
|
+
* instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
|
|
52
|
+
*/
|
|
53
|
+
name?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups
|
|
56
|
+
* may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or
|
|
57
|
+
* cancelled or the destination backup is deleted), the reference to the backup is removed.
|
|
58
|
+
*/
|
|
59
|
+
referencingBackups?: string[];
|
|
60
|
+
/**
|
|
61
|
+
* Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in
|
|
62
|
+
* different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the
|
|
63
|
+
* reference to the backup is removed.
|
|
64
|
+
*/
|
|
65
|
+
referencingDatabases?: string[];
|
|
66
|
+
/** Output only. Size of the backup in bytes. */
|
|
67
|
+
sizeBytes?: string;
|
|
68
|
+
/** Output only. The current state of the backup. */
|
|
69
|
+
state?: string;
|
|
70
|
+
/**
|
|
71
|
+
* The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set
|
|
72
|
+
* `version_time` to the `create_time` of the backup.
|
|
73
|
+
*/
|
|
74
|
+
versionTime?: string;
|
|
75
|
+
}
|
|
76
|
+
interface BackupInfo {
|
|
77
|
+
/** Name of the backup. */
|
|
78
|
+
backup?: string;
|
|
79
|
+
/** The time the CreateBackup request was received. */
|
|
80
|
+
createTime?: string;
|
|
81
|
+
/** Name of the database the backup was created from. */
|
|
82
|
+
sourceDatabase?: string;
|
|
83
|
+
/**
|
|
84
|
+
* 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
|
|
85
|
+
* `version_time` of the backup is equivalent to the `create_time`.
|
|
86
|
+
*/
|
|
87
|
+
versionTime?: string;
|
|
88
|
+
}
|
|
89
|
+
interface BatchCreateSessionsRequest {
|
|
90
|
+
/**
|
|
91
|
+
* Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the
|
|
92
|
+
* client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).
|
|
93
|
+
*/
|
|
94
|
+
sessionCount?: number;
|
|
95
|
+
/** Parameters to be applied to each created session. */
|
|
96
|
+
sessionTemplate?: Session;
|
|
97
|
+
}
|
|
98
|
+
interface BatchCreateSessionsResponse {
|
|
99
|
+
/** The freshly created sessions. */
|
|
100
|
+
session?: Session[];
|
|
101
|
+
}
|
|
102
|
+
interface BeginTransactionRequest {
|
|
103
|
+
/** Required. Options for the new transaction. */
|
|
104
|
+
options?: TransactionOptions;
|
|
105
|
+
/**
|
|
106
|
+
* Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a
|
|
107
|
+
* transaction, set it on the reads and writes that are part of this transaction instead.
|
|
108
|
+
*/
|
|
109
|
+
requestOptions?: RequestOptions;
|
|
110
|
+
}
|
|
111
|
+
interface Binding {
|
|
112
|
+
/**
|
|
113
|
+
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`,
|
|
114
|
+
* then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which
|
|
115
|
+
* resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
116
|
+
*/
|
|
117
|
+
condition?: Expr;
|
|
118
|
+
/**
|
|
119
|
+
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
|
|
120
|
+
* the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service
|
|
121
|
+
* account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
|
|
122
|
+
* represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example,
|
|
123
|
+
* `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
|
|
124
|
+
* `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. *
|
|
125
|
+
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
|
|
126
|
+
* `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
|
|
127
|
+
* account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently
|
|
128
|
+
* deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in
|
|
129
|
+
* the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
|
|
130
|
+
*/
|
|
131
|
+
members?: string[];
|
|
132
|
+
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
|
|
133
|
+
role?: string;
|
|
134
|
+
}
|
|
135
|
+
interface ChildLink {
|
|
136
|
+
/** The node to which the link points. */
|
|
137
|
+
childIndex?: number;
|
|
138
|
+
/**
|
|
139
|
+
* The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable,
|
|
140
|
+
* to represent the tag associated with the output variable.
|
|
141
|
+
*/
|
|
142
|
+
type?: string;
|
|
143
|
+
/**
|
|
144
|
+
* Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a `TableScan`
|
|
145
|
+
* operator that reads rows from a table will have child links to the `SCALAR` nodes representing the output variables created for each column that is read by the operator. The
|
|
146
|
+
* corresponding `variable` fields will be set to the variable names assigned to the columns.
|
|
147
|
+
*/
|
|
148
|
+
variable?: string;
|
|
149
|
+
}
|
|
150
|
+
interface CommitRequest {
|
|
151
|
+
/** The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. */
|
|
152
|
+
mutations?: Mutation[];
|
|
153
|
+
/** Common options for this request. */
|
|
154
|
+
requestOptions?: RequestOptions;
|
|
155
|
+
/** If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`. */
|
|
156
|
+
returnCommitStats?: boolean;
|
|
157
|
+
/**
|
|
158
|
+
* Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the
|
|
159
|
+
* `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are
|
|
160
|
+
* executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
|
|
161
|
+
*/
|
|
162
|
+
singleUseTransaction?: TransactionOptions;
|
|
163
|
+
/** Commit a previously-started transaction. */
|
|
164
|
+
transactionId?: string;
|
|
165
|
+
}
|
|
166
|
+
interface CommitResponse {
|
|
167
|
+
/** The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats. */
|
|
168
|
+
commitStats?: CommitStats;
|
|
169
|
+
/** The Cloud Spanner timestamp at which the transaction committed. */
|
|
170
|
+
commitTimestamp?: string;
|
|
171
|
+
}
|
|
172
|
+
interface CommitStats {
|
|
173
|
+
/**
|
|
174
|
+
* 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
|
|
175
|
+
* round trips. You can also monitor this value to prevent transactions from exceeding the system
|
|
176
|
+
* [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
|
|
177
|
+
* [INVALID_ARGUMENT](https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
|
|
178
|
+
*/
|
|
179
|
+
mutationCount?: string;
|
|
180
|
+
}
|
|
181
|
+
interface ContextValue {
|
|
182
|
+
/** The label for the context value. e.g. "latency". */
|
|
183
|
+
label?: LocalizedString;
|
|
184
|
+
/** The severity of this context. */
|
|
185
|
+
severity?: string;
|
|
186
|
+
/** The unit of the context value. */
|
|
187
|
+
unit?: string;
|
|
188
|
+
/** The value for the context. */
|
|
189
|
+
value?: number;
|
|
190
|
+
}
|
|
191
|
+
interface CopyBackupEncryptionConfig {
|
|
192
|
+
/** Required. The encryption type of the backup. */
|
|
193
|
+
encryptionType?: string;
|
|
194
|
+
/**
|
|
195
|
+
* 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
|
|
196
|
+
* `projects//locations//keyRings//cryptoKeys/`.
|
|
197
|
+
*/
|
|
198
|
+
kmsKeyName?: string;
|
|
199
|
+
}
|
|
200
|
+
interface CopyBackupMetadata {
|
|
201
|
+
/**
|
|
202
|
+
* The time at which cancellation of CopyBackup operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best
|
|
203
|
+
* effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
204
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
205
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
206
|
+
*/
|
|
207
|
+
cancelTime?: string;
|
|
208
|
+
/** The name of the backup being created through the copy operation. Values are of the form `projects//instances//backups/`. */
|
|
209
|
+
name?: string;
|
|
210
|
+
/** The progress of the CopyBackup operation. */
|
|
211
|
+
progress?: OperationProgress;
|
|
212
|
+
/** The name of the source backup that is being copied. Values are of the form `projects//instances//backups/`. */
|
|
213
|
+
sourceBackup?: string;
|
|
214
|
+
}
|
|
215
|
+
interface CopyBackupRequest {
|
|
216
|
+
/** Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects//instances//backups/`. */
|
|
217
|
+
backupId?: string;
|
|
218
|
+
/**
|
|
219
|
+
* Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by
|
|
220
|
+
* default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
|
|
221
|
+
*/
|
|
222
|
+
encryptionConfig?: CopyBackupEncryptionConfig;
|
|
223
|
+
/**
|
|
224
|
+
* Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source
|
|
225
|
+
* backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
|
|
226
|
+
*/
|
|
227
|
+
expireTime?: string;
|
|
228
|
+
/**
|
|
229
|
+
* Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or
|
|
230
|
+
* cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects//instances//backups/`.
|
|
231
|
+
*/
|
|
232
|
+
sourceBackup?: string;
|
|
233
|
+
}
|
|
234
|
+
interface CreateBackupMetadata {
|
|
235
|
+
/**
|
|
236
|
+
* The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best
|
|
237
|
+
* effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
238
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
239
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
240
|
+
*/
|
|
241
|
+
cancelTime?: string;
|
|
242
|
+
/** The name of the database the backup is created from. */
|
|
243
|
+
database?: string;
|
|
244
|
+
/** The name of the backup being created. */
|
|
245
|
+
name?: string;
|
|
246
|
+
/** The progress of the CreateBackup operation. */
|
|
247
|
+
progress?: OperationProgress;
|
|
248
|
+
}
|
|
249
|
+
interface CreateDatabaseMetadata {
|
|
250
|
+
/** The database being created. */
|
|
251
|
+
database?: string;
|
|
252
|
+
}
|
|
253
|
+
interface CreateDatabaseRequest {
|
|
254
|
+
/**
|
|
255
|
+
* Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30
|
|
256
|
+
* characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``).
|
|
257
|
+
*/
|
|
258
|
+
createStatement?: string;
|
|
259
|
+
/** Optional. The dialect of the Cloud Spanner Database. */
|
|
260
|
+
databaseDialect?: string;
|
|
261
|
+
/** Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption. */
|
|
262
|
+
encryptionConfig?: EncryptionConfig;
|
|
263
|
+
/**
|
|
264
|
+
* Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the
|
|
265
|
+
* database: if there is an error in any statement, the database is not created.
|
|
266
|
+
*/
|
|
267
|
+
extraStatements?: string[];
|
|
268
|
+
}
|
|
269
|
+
interface CreateInstanceMetadata {
|
|
270
|
+
/** The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */
|
|
271
|
+
cancelTime?: string;
|
|
272
|
+
/** The time at which this operation failed or was completed successfully. */
|
|
273
|
+
endTime?: string;
|
|
274
|
+
/** The instance being created. */
|
|
275
|
+
instance?: Instance;
|
|
276
|
+
/** The time at which the CreateInstance request was received. */
|
|
277
|
+
startTime?: string;
|
|
278
|
+
}
|
|
279
|
+
interface CreateInstanceRequest {
|
|
280
|
+
/** Required. The instance to create. The name may be omitted, but if specified must be `/instances/`. */
|
|
281
|
+
instance?: Instance;
|
|
282
|
+
/** Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. */
|
|
283
|
+
instanceId?: string;
|
|
284
|
+
}
|
|
285
|
+
interface CreateSessionRequest {
|
|
286
|
+
/** Required. The session to create. */
|
|
287
|
+
session?: Session;
|
|
288
|
+
}
|
|
289
|
+
interface Database {
|
|
290
|
+
/** Output only. If exists, the time at which the database creation started. */
|
|
291
|
+
createTime?: string;
|
|
292
|
+
/** Output only. The dialect of the Cloud Spanner Database. */
|
|
293
|
+
databaseDialect?: string;
|
|
294
|
+
/**
|
|
295
|
+
* Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using
|
|
296
|
+
* DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
|
|
297
|
+
*/
|
|
298
|
+
defaultLeader?: string;
|
|
299
|
+
/**
|
|
300
|
+
* Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If
|
|
301
|
+
* you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
|
|
302
|
+
*/
|
|
303
|
+
earliestVersionTime?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default
|
|
306
|
+
* or other types of encryption, this field is empty.
|
|
307
|
+
*/
|
|
308
|
+
encryptionConfig?: EncryptionConfig;
|
|
309
|
+
/**
|
|
310
|
+
* Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as encryption state and the Cloud KMS
|
|
311
|
+
* key versions that are in use. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There
|
|
312
|
+
* might be a delay from when a key version is being used and when it appears in this field.
|
|
313
|
+
*/
|
|
314
|
+
encryptionInfo?: EncryptionInfo[];
|
|
315
|
+
/**
|
|
316
|
+
* Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to
|
|
317
|
+
* other API methods to identify the database.
|
|
318
|
+
*/
|
|
319
|
+
name?: string;
|
|
320
|
+
/** Output only. Applicable only for restored databases. Contains information about the restore source. */
|
|
321
|
+
restoreInfo?: RestoreInfo;
|
|
322
|
+
/** Output only. The current database state. */
|
|
323
|
+
state?: string;
|
|
324
|
+
/**
|
|
325
|
+
* 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
|
|
326
|
+
* UpdateDatabaseDdl. Defaults to 1 hour, if not set.
|
|
327
|
+
*/
|
|
328
|
+
versionRetentionPeriod?: string;
|
|
329
|
+
}
|
|
330
|
+
interface DatabaseRole {
|
|
331
|
+
/**
|
|
332
|
+
* Required. The name of the database role. Values are of the form `projects//instances//databases//databaseRoles/ {role}`, where `` is as specified in the `CREATE ROLE` DDL statement.
|
|
333
|
+
* This name can be passed to Get/Set IAMPolicy methods to identify the database role.
|
|
334
|
+
*/
|
|
335
|
+
name?: string;
|
|
336
|
+
}
|
|
337
|
+
interface Delete {
|
|
338
|
+
/**
|
|
339
|
+
* Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the `PRIMARY KEY()` clause of the table's
|
|
340
|
+
* equivalent DDL statement (the DDL statement used to create the table). Delete is idempotent. The transaction will succeed even if some or all rows do not exist.
|
|
341
|
+
*/
|
|
342
|
+
keySet?: KeySet;
|
|
343
|
+
/** Required. The table whose rows will be deleted. */
|
|
344
|
+
table?: string;
|
|
345
|
+
}
|
|
346
|
+
interface DerivedMetric {
|
|
347
|
+
/** The name of the denominator metric. e.g. "rows". */
|
|
348
|
+
denominator?: LocalizedString;
|
|
349
|
+
/** The name of the numerator metric. e.g. "latency". */
|
|
350
|
+
numerator?: LocalizedString;
|
|
351
|
+
}
|
|
352
|
+
interface DiagnosticMessage {
|
|
353
|
+
/** Information about this diagnostic information. */
|
|
354
|
+
info?: LocalizedString;
|
|
355
|
+
/** The metric. */
|
|
356
|
+
metric?: LocalizedString;
|
|
357
|
+
/**
|
|
358
|
+
* Whether this message is specific only for the current metric. By default Diagnostics are shown for all metrics, regardless which metric is the currently selected metric in the UI.
|
|
359
|
+
* However occasionally a metric will generate so many messages that the resulting visual clutter becomes overwhelming. In this case setting this to true, will show the diagnostic
|
|
360
|
+
* messages for that metric only if it is the currently selected metric.
|
|
361
|
+
*/
|
|
362
|
+
metricSpecific?: boolean;
|
|
363
|
+
/** The severity of the diagnostic message. */
|
|
364
|
+
severity?: string;
|
|
365
|
+
/** The short message. */
|
|
366
|
+
shortMessage?: LocalizedString;
|
|
367
|
+
}
|
|
368
|
+
// tslint:disable-next-line:no-empty-interface
|
|
369
|
+
interface Empty {
|
|
370
|
+
}
|
|
371
|
+
interface EncryptionConfig {
|
|
372
|
+
/** The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
373
|
+
kmsKeyName?: string;
|
|
374
|
+
}
|
|
375
|
+
interface EncryptionInfo {
|
|
376
|
+
/** Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest. */
|
|
377
|
+
encryptionStatus?: Status;
|
|
378
|
+
/** Output only. The type of encryption. */
|
|
379
|
+
encryptionType?: string;
|
|
380
|
+
/** Output only. A Cloud KMS key version that is being used to protect the database or backup. */
|
|
381
|
+
kmsKeyVersion?: string;
|
|
382
|
+
}
|
|
383
|
+
interface ExecuteBatchDmlRequest {
|
|
384
|
+
/** Common options for this request. */
|
|
385
|
+
requestOptions?: RequestOptions;
|
|
386
|
+
/**
|
|
387
|
+
* Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one
|
|
388
|
+
* will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the
|
|
389
|
+
* transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.
|
|
390
|
+
*/
|
|
391
|
+
seqno?: string;
|
|
392
|
+
/**
|
|
393
|
+
* Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement
|
|
394
|
+
* must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement.
|
|
395
|
+
*/
|
|
396
|
+
statements?: Statement[];
|
|
397
|
+
/**
|
|
398
|
+
* Required. The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing
|
|
399
|
+
* transaction ID or begin a new transaction.
|
|
400
|
+
*/
|
|
401
|
+
transaction?: TransactionSelector;
|
|
402
|
+
}
|
|
403
|
+
interface ExecuteBatchDmlResponse {
|
|
404
|
+
/**
|
|
405
|
+
* One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The
|
|
406
|
+
* ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata.
|
|
407
|
+
*/
|
|
408
|
+
resultSets?: ResultSet[];
|
|
409
|
+
/** If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement. */
|
|
410
|
+
status?: Status;
|
|
411
|
+
}
|
|
412
|
+
interface ExecuteSqlRequest {
|
|
413
|
+
/**
|
|
414
|
+
* Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example,
|
|
415
|
+
* `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can
|
|
416
|
+
* appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to
|
|
417
|
+
* execute a SQL statement with unbound parameters.
|
|
418
|
+
*/
|
|
419
|
+
params?: { [P in string]: any };
|
|
420
|
+
/**
|
|
421
|
+
* It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as
|
|
422
|
+
* JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more
|
|
423
|
+
* information about SQL types.
|
|
424
|
+
*/
|
|
425
|
+
paramTypes?: { [P in string]: Type };
|
|
426
|
+
/**
|
|
427
|
+
* If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this
|
|
428
|
+
* message and the PartitionQueryRequest message used to create this partition_token.
|
|
429
|
+
*/
|
|
430
|
+
partitionToken?: string;
|
|
431
|
+
/** Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. */
|
|
432
|
+
queryMode?: string;
|
|
433
|
+
/** Query optimizer configuration to use for the given query. */
|
|
434
|
+
queryOptions?: QueryOptions;
|
|
435
|
+
/** Common options for this request. */
|
|
436
|
+
requestOptions?: RequestOptions;
|
|
437
|
+
/**
|
|
438
|
+
* If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing
|
|
439
|
+
* this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
|
|
440
|
+
*/
|
|
441
|
+
resumeToken?: string;
|
|
442
|
+
/**
|
|
443
|
+
* A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will
|
|
444
|
+
* succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction
|
|
445
|
+
* may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries.
|
|
446
|
+
*/
|
|
447
|
+
seqno?: string;
|
|
448
|
+
/** Required. The SQL string. */
|
|
449
|
+
sql?: string;
|
|
450
|
+
/**
|
|
451
|
+
* The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write
|
|
452
|
+
* transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned
|
|
453
|
+
* DML requires an existing Partitioned DML transaction ID.
|
|
454
|
+
*/
|
|
455
|
+
transaction?: TransactionSelector;
|
|
456
|
+
}
|
|
457
|
+
interface Expr {
|
|
458
|
+
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
459
|
+
description?: string;
|
|
460
|
+
/** Textual representation of an expression in Common Expression Language syntax. */
|
|
461
|
+
expression?: string;
|
|
462
|
+
/** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
|
|
463
|
+
location?: string;
|
|
464
|
+
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
465
|
+
title?: string;
|
|
466
|
+
}
|
|
467
|
+
interface Field {
|
|
468
|
+
/**
|
|
469
|
+
* The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name
|
|
470
|
+
* (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain
|
|
471
|
+
* multiple fields with the same name.
|
|
472
|
+
*/
|
|
473
|
+
name?: string;
|
|
474
|
+
/** The type of the field. */
|
|
475
|
+
type?: Type;
|
|
476
|
+
}
|
|
477
|
+
interface FreeInstanceMetadata {
|
|
478
|
+
/**
|
|
479
|
+
* Specifies the expiration behavior of a free instance. The default of ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during or after creation, and before
|
|
480
|
+
* expiration.
|
|
481
|
+
*/
|
|
482
|
+
expireBehavior?: string;
|
|
483
|
+
/**
|
|
484
|
+
* Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or
|
|
485
|
+
* scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
|
|
486
|
+
*/
|
|
487
|
+
expireTime?: string;
|
|
488
|
+
/** Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance. */
|
|
489
|
+
upgradeTime?: string;
|
|
490
|
+
}
|
|
491
|
+
interface GetDatabaseDdlResponse {
|
|
492
|
+
/** A list of formatted DDL statements defining the schema of the database specified in the request. */
|
|
493
|
+
statements?: string[];
|
|
494
|
+
}
|
|
495
|
+
interface GetIamPolicyRequest {
|
|
496
|
+
/** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
|
|
497
|
+
options?: GetPolicyOptions;
|
|
498
|
+
}
|
|
499
|
+
interface GetPolicyOptions {
|
|
500
|
+
/**
|
|
501
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
502
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in
|
|
503
|
+
* the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role
|
|
504
|
+
* bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
505
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
506
|
+
*/
|
|
507
|
+
requestedPolicyVersion?: number;
|
|
508
|
+
}
|
|
509
|
+
interface IndexedHotKey {
|
|
510
|
+
/**
|
|
511
|
+
* A (sparse) mapping from key bucket index to the index of the specific hot row key for that key bucket. The index of the hot row key can be translated to the actual row key via the
|
|
512
|
+
* ScanData.VisualizationData.indexed_keys repeated field.
|
|
513
|
+
*/
|
|
514
|
+
sparseHotKeys?: { [P in string]: number };
|
|
515
|
+
}
|
|
516
|
+
interface IndexedKeyRangeInfos {
|
|
517
|
+
/** A (sparse) mapping from key bucket index to the KeyRangeInfos for that key bucket. */
|
|
518
|
+
keyRangeInfos?: { [P in string]: KeyRangeInfos };
|
|
519
|
+
}
|
|
520
|
+
interface Instance {
|
|
521
|
+
/** Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. */
|
|
522
|
+
config?: string;
|
|
523
|
+
/** Output only. The time at which the instance was created. */
|
|
524
|
+
createTime?: string;
|
|
525
|
+
/** Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. */
|
|
526
|
+
displayName?: string;
|
|
527
|
+
/** Deprecated. This field is not populated. */
|
|
528
|
+
endpointUris?: string[];
|
|
529
|
+
/** Free instance metadata. Only populated for free instances. */
|
|
530
|
+
freeInstanceMetadata?: FreeInstanceMetadata;
|
|
531
|
+
/** The `InstanceType` of the current instance. */
|
|
532
|
+
instanceType?: string;
|
|
533
|
+
/**
|
|
534
|
+
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud
|
|
535
|
+
* Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules
|
|
536
|
+
* (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values
|
|
537
|
+
* must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See
|
|
538
|
+
* https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the
|
|
539
|
+
* future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels
|
|
540
|
+
* as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
|
|
541
|
+
*/
|
|
542
|
+
labels?: { [P in string]: string };
|
|
543
|
+
/**
|
|
544
|
+
* Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment
|
|
545
|
+
* of the name must be between 2 and 64 characters in length.
|
|
546
|
+
*/
|
|
547
|
+
name?: string;
|
|
548
|
+
/**
|
|
549
|
+
* The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. This may be zero in API responses for
|
|
550
|
+
* instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
|
|
551
|
+
*/
|
|
552
|
+
nodeCount?: number;
|
|
553
|
+
/**
|
|
554
|
+
* The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for
|
|
555
|
+
* instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
|
|
556
|
+
*/
|
|
557
|
+
processingUnits?: number;
|
|
558
|
+
/**
|
|
559
|
+
* Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to
|
|
560
|
+
* `READY`.
|
|
561
|
+
*/
|
|
562
|
+
state?: string;
|
|
563
|
+
/** Output only. The time at which the instance was most recently updated. */
|
|
564
|
+
updateTime?: string;
|
|
565
|
+
}
|
|
566
|
+
interface InstanceConfig {
|
|
567
|
+
/** The name of this instance configuration as it appears in UIs. */
|
|
568
|
+
displayName?: string;
|
|
569
|
+
/** Output only. Describes whether free instances are available to be created in this instance config. */
|
|
570
|
+
freeInstanceAvailability?: string;
|
|
571
|
+
/** Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. */
|
|
572
|
+
leaderOptions?: string[];
|
|
573
|
+
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. */
|
|
574
|
+
name?: string;
|
|
575
|
+
/** The geographic placement of nodes in this instance configuration and their replication properties. */
|
|
576
|
+
replicas?: ReplicaInfo[];
|
|
577
|
+
}
|
|
578
|
+
interface KeyRange {
|
|
579
|
+
/** If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`. */
|
|
580
|
+
endClosed?: any[];
|
|
581
|
+
/** If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`. */
|
|
582
|
+
endOpen?: any[];
|
|
583
|
+
/** If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`. */
|
|
584
|
+
startClosed?: any[];
|
|
585
|
+
/** If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`. */
|
|
586
|
+
startOpen?: any[];
|
|
587
|
+
}
|
|
588
|
+
interface KeyRangeInfo {
|
|
589
|
+
/** The list of context values for this key range. */
|
|
590
|
+
contextValues?: ContextValue[];
|
|
591
|
+
/** The index of the end key in indexed_keys. */
|
|
592
|
+
endKeyIndex?: number;
|
|
593
|
+
/** Information about this key range, for all metrics. */
|
|
594
|
+
info?: LocalizedString;
|
|
595
|
+
/** The number of keys this range covers. */
|
|
596
|
+
keysCount?: string;
|
|
597
|
+
/** The name of the metric. e.g. "latency". */
|
|
598
|
+
metric?: LocalizedString;
|
|
599
|
+
/** The index of the start key in indexed_keys. */
|
|
600
|
+
startKeyIndex?: number;
|
|
601
|
+
/** The time offset. This is the time since the start of the time interval. */
|
|
602
|
+
timeOffset?: string;
|
|
603
|
+
/** The unit of the metric. This is an unstructured field and will be mapped as is to the user. */
|
|
604
|
+
unit?: LocalizedString;
|
|
605
|
+
/** The value of the metric. */
|
|
606
|
+
value?: number;
|
|
607
|
+
}
|
|
608
|
+
interface KeyRangeInfos {
|
|
609
|
+
/** The list individual KeyRangeInfos. */
|
|
610
|
+
infos?: KeyRangeInfo[];
|
|
611
|
+
/**
|
|
612
|
+
* The total size of the list of all KeyRangeInfos. This may be larger than the number of repeated messages above. If that is the case, this number may be used to determine how many
|
|
613
|
+
* are not being shown.
|
|
614
|
+
*/
|
|
615
|
+
totalSize?: number;
|
|
616
|
+
}
|
|
617
|
+
interface KeySet {
|
|
618
|
+
/**
|
|
619
|
+
* For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index. Note that any keys specified in `keys` or `ranges` are only yielded
|
|
620
|
+
* once.
|
|
621
|
+
*/
|
|
622
|
+
all?: boolean;
|
|
623
|
+
/**
|
|
624
|
+
* A list of specific keys. Entries in `keys` should have exactly as many elements as there are columns in the primary or index key with which this `KeySet` is used. Individual key
|
|
625
|
+
* values are encoded as described here.
|
|
626
|
+
*/
|
|
627
|
+
keys?: any[][];
|
|
628
|
+
/** A list of key ranges. See KeyRange for more information about key range specifications. */
|
|
629
|
+
ranges?: KeyRange[];
|
|
630
|
+
}
|
|
631
|
+
interface ListBackupOperationsResponse {
|
|
632
|
+
/** `next_page_token` can be sent in a subsequent ListBackupOperations call to fetch more of the matching metadata. */
|
|
633
|
+
nextPageToken?: string;
|
|
634
|
+
/**
|
|
635
|
+
* The list of matching backup long-running operations. Each operation's name will be prefixed by the backup's name. The operation's metadata field type `metadata.type_url` describes
|
|
636
|
+
* the type of the metadata. Operations returned include those that are pending or have completed/failed/canceled within the last 7 days. Operations returned are ordered by
|
|
637
|
+
* `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.
|
|
638
|
+
*/
|
|
639
|
+
operations?: Operation[];
|
|
640
|
+
}
|
|
641
|
+
interface ListBackupsResponse {
|
|
642
|
+
/** The list of matching backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. */
|
|
643
|
+
backups?: Backup[];
|
|
644
|
+
/** `next_page_token` can be sent in a subsequent ListBackups call to fetch more of the matching backups. */
|
|
645
|
+
nextPageToken?: string;
|
|
646
|
+
}
|
|
647
|
+
interface ListDatabaseOperationsResponse {
|
|
648
|
+
/** `next_page_token` can be sent in a subsequent ListDatabaseOperations call to fetch more of the matching metadata. */
|
|
649
|
+
nextPageToken?: string;
|
|
650
|
+
/**
|
|
651
|
+
* The list of matching database long-running operations. Each operation's name will be prefixed by the database's name. The operation's metadata field type `metadata.type_url`
|
|
652
|
+
* describes the type of the metadata.
|
|
653
|
+
*/
|
|
654
|
+
operations?: Operation[];
|
|
655
|
+
}
|
|
656
|
+
interface ListDatabaseRolesResponse {
|
|
657
|
+
/** Database roles that matched the request. */
|
|
658
|
+
databaseRoles?: DatabaseRole[];
|
|
659
|
+
/** `next_page_token` can be sent in a subsequent ListDatabaseRoles call to fetch more of the matching roles. */
|
|
660
|
+
nextPageToken?: string;
|
|
661
|
+
}
|
|
662
|
+
interface ListDatabasesResponse {
|
|
663
|
+
/** Databases that matched the request. */
|
|
664
|
+
databases?: Database[];
|
|
665
|
+
/** `next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases. */
|
|
666
|
+
nextPageToken?: string;
|
|
667
|
+
}
|
|
668
|
+
interface ListInstanceConfigsResponse {
|
|
669
|
+
/** The list of requested instance configurations. */
|
|
670
|
+
instanceConfigs?: InstanceConfig[];
|
|
671
|
+
/** `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. */
|
|
672
|
+
nextPageToken?: string;
|
|
673
|
+
}
|
|
674
|
+
interface ListInstancesResponse {
|
|
675
|
+
/** The list of requested instances. */
|
|
676
|
+
instances?: Instance[];
|
|
677
|
+
/** `next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances. */
|
|
678
|
+
nextPageToken?: string;
|
|
679
|
+
/** The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline. */
|
|
680
|
+
unreachable?: string[];
|
|
681
|
+
}
|
|
682
|
+
interface ListOperationsResponse {
|
|
683
|
+
/** The standard List next-page token. */
|
|
684
|
+
nextPageToken?: string;
|
|
685
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
686
|
+
operations?: Operation[];
|
|
687
|
+
}
|
|
688
|
+
interface ListScansResponse {
|
|
689
|
+
/** Token to retrieve the next page of results, or empty if there are no more results in the list. */
|
|
690
|
+
nextPageToken?: string;
|
|
691
|
+
/** Available scans based on the list query parameters. */
|
|
692
|
+
scans?: Scan[];
|
|
693
|
+
}
|
|
694
|
+
interface ListSessionsResponse {
|
|
695
|
+
/** `next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions. */
|
|
696
|
+
nextPageToken?: string;
|
|
697
|
+
/** The list of requested sessions. */
|
|
698
|
+
sessions?: Session[];
|
|
699
|
+
}
|
|
700
|
+
interface LocalizedString {
|
|
701
|
+
/** A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values. */
|
|
702
|
+
args?: { [P in string]: string };
|
|
703
|
+
/** The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is. */
|
|
704
|
+
message?: string;
|
|
705
|
+
/** The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service. */
|
|
706
|
+
token?: string;
|
|
707
|
+
}
|
|
708
|
+
interface Metric {
|
|
709
|
+
/** The aggregation function used to aggregate each key bucket */
|
|
710
|
+
aggregation?: string;
|
|
711
|
+
/** The category of the metric, e.g. "Activity", "Alerts", "Reads", etc. */
|
|
712
|
+
category?: LocalizedString;
|
|
713
|
+
/** The references to numerator and denominator metrics for a derived metric. */
|
|
714
|
+
derived?: DerivedMetric;
|
|
715
|
+
/** The displayed label of the metric. */
|
|
716
|
+
displayLabel?: LocalizedString;
|
|
717
|
+
/** Whether the metric has any non-zero data. */
|
|
718
|
+
hasNonzeroData?: boolean;
|
|
719
|
+
/**
|
|
720
|
+
* The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user.
|
|
721
|
+
* hot_value is used to calibrate and scale visual color scales.
|
|
722
|
+
*/
|
|
723
|
+
hotValue?: number;
|
|
724
|
+
/** The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys. */
|
|
725
|
+
indexedHotKeys?: { [P in string]: IndexedHotKey };
|
|
726
|
+
/** The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges. */
|
|
727
|
+
indexedKeyRangeInfos?: { [P in string]: IndexedKeyRangeInfos };
|
|
728
|
+
/** Information about the metric. */
|
|
729
|
+
info?: LocalizedString;
|
|
730
|
+
/** The data for the metric as a matrix. */
|
|
731
|
+
matrix?: MetricMatrix;
|
|
732
|
+
/** The unit of the metric. */
|
|
733
|
+
unit?: LocalizedString;
|
|
734
|
+
/** Whether the metric is visible to the end user. */
|
|
735
|
+
visible?: boolean;
|
|
736
|
+
}
|
|
737
|
+
interface MetricMatrix {
|
|
738
|
+
/** The rows of the matrix. */
|
|
739
|
+
rows?: MetricMatrixRow[];
|
|
740
|
+
}
|
|
741
|
+
interface MetricMatrixRow {
|
|
742
|
+
/** The columns of the row. */
|
|
743
|
+
cols?: number[];
|
|
744
|
+
}
|
|
745
|
+
interface Mutation {
|
|
746
|
+
/** Delete rows from a table. Succeeds whether or not the named rows were present. */
|
|
747
|
+
delete?: Delete;
|
|
748
|
+
/** Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`. */
|
|
749
|
+
insert?: Write;
|
|
750
|
+
/**
|
|
751
|
+
* Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. When using
|
|
752
|
+
* insert_or_update, just as when using insert, all `NOT NULL` columns in the table must be given a value. This holds true even when the row already exists and will therefore actually
|
|
753
|
+
* be updated.
|
|
754
|
+
*/
|
|
755
|
+
insertOrUpdate?: Write;
|
|
756
|
+
/**
|
|
757
|
+
* Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly
|
|
758
|
+
* written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows.
|
|
759
|
+
* Otherwise, you must delete the child rows before you replace the parent row.
|
|
760
|
+
*/
|
|
761
|
+
replace?: Write;
|
|
762
|
+
/** Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`. */
|
|
763
|
+
update?: Write;
|
|
764
|
+
}
|
|
765
|
+
interface Operation {
|
|
766
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
767
|
+
done?: boolean;
|
|
768
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
769
|
+
error?: Status;
|
|
770
|
+
/**
|
|
771
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
772
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
773
|
+
*/
|
|
774
|
+
metadata?: { [P in string]: any };
|
|
775
|
+
/**
|
|
776
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
777
|
+
* with `operations/{unique_id}`.
|
|
778
|
+
*/
|
|
779
|
+
name?: string;
|
|
780
|
+
/**
|
|
781
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
782
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
783
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
784
|
+
*/
|
|
785
|
+
response?: { [P in string]: any };
|
|
786
|
+
}
|
|
787
|
+
interface OperationProgress {
|
|
788
|
+
/** If set, the time at which this operation failed or was completed successfully. */
|
|
789
|
+
endTime?: string;
|
|
790
|
+
/** Percent completion of the operation. Values are between 0 and 100 inclusive. */
|
|
791
|
+
progressPercent?: number;
|
|
792
|
+
/** Time the request was received. */
|
|
793
|
+
startTime?: string;
|
|
794
|
+
}
|
|
795
|
+
interface OptimizeRestoredDatabaseMetadata {
|
|
796
|
+
/** Name of the restored database being optimized. */
|
|
797
|
+
name?: string;
|
|
798
|
+
/** The progress of the post-restore optimizations. */
|
|
799
|
+
progress?: OperationProgress;
|
|
800
|
+
}
|
|
801
|
+
interface PartialResultSet {
|
|
802
|
+
/** If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. */
|
|
803
|
+
chunkedValue?: boolean;
|
|
804
|
+
/** Metadata about the result set, such as row type information. Only present in the first response. */
|
|
805
|
+
metadata?: ResultSetMetadata;
|
|
806
|
+
/**
|
|
807
|
+
* Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request
|
|
808
|
+
* and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
|
|
809
|
+
*/
|
|
810
|
+
resumeToken?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once
|
|
813
|
+
* with the last response in the stream. This field will also be present in the last response for DML statements.
|
|
814
|
+
*/
|
|
815
|
+
stats?: ResultSetStats;
|
|
816
|
+
/**
|
|
817
|
+
* A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete
|
|
818
|
+
* values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last
|
|
819
|
+
* value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values
|
|
820
|
+
* can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element
|
|
821
|
+
* in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field
|
|
822
|
+
* value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" =>
|
|
823
|
+
* "foobar" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a",
|
|
824
|
+
* "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the
|
|
825
|
+
* inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} =>
|
|
826
|
+
* {"a": "1", "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} # Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a":
|
|
827
|
+
* ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following
|
|
828
|
+
* `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } {
|
|
829
|
+
* "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value
|
|
830
|
+
* `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence
|
|
831
|
+
* of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` will yield results from the `PartialResultSet` with value `["orl"]`.
|
|
832
|
+
*/
|
|
833
|
+
values?: any[];
|
|
834
|
+
}
|
|
835
|
+
interface Partition {
|
|
836
|
+
/** This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token. */
|
|
837
|
+
partitionToken?: string;
|
|
838
|
+
}
|
|
839
|
+
// tslint:disable-next-line:no-empty-interface
|
|
840
|
+
interface PartitionedDml {
|
|
841
|
+
}
|
|
842
|
+
interface PartitionOptions {
|
|
843
|
+
/**
|
|
844
|
+
* **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number
|
|
845
|
+
* of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be
|
|
846
|
+
* smaller or larger than this maximum count request.
|
|
847
|
+
*/
|
|
848
|
+
maxPartitions?: string;
|
|
849
|
+
/**
|
|
850
|
+
* **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1
|
|
851
|
+
* GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.
|
|
852
|
+
*/
|
|
853
|
+
partitionSizeBytes?: string;
|
|
854
|
+
}
|
|
855
|
+
interface PartitionQueryRequest {
|
|
856
|
+
/**
|
|
857
|
+
* Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example,
|
|
858
|
+
* `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used
|
|
859
|
+
* more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
|
|
860
|
+
*/
|
|
861
|
+
params?: { [P in string]: any };
|
|
862
|
+
/**
|
|
863
|
+
* It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as
|
|
864
|
+
* JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information
|
|
865
|
+
* about SQL types.
|
|
866
|
+
*/
|
|
867
|
+
paramTypes?: { [P in string]: Type };
|
|
868
|
+
/** Additional options that affect how many partitions are created. */
|
|
869
|
+
partitionOptions?: PartitionOptions;
|
|
870
|
+
/**
|
|
871
|
+
* Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single
|
|
872
|
+
* distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and
|
|
873
|
+
* then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large,
|
|
874
|
+
* partition-friendly DML operations.
|
|
875
|
+
*/
|
|
876
|
+
sql?: string;
|
|
877
|
+
/** Read only snapshot transactions are supported, read/write and single use transactions are not. */
|
|
878
|
+
transaction?: TransactionSelector;
|
|
879
|
+
}
|
|
880
|
+
interface PartitionReadRequest {
|
|
881
|
+
/** The columns of table to be returned for each row matching this request. */
|
|
882
|
+
columns?: string[];
|
|
883
|
+
/**
|
|
884
|
+
* If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further
|
|
885
|
+
* information.
|
|
886
|
+
*/
|
|
887
|
+
index?: string;
|
|
888
|
+
/**
|
|
889
|
+
* Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then
|
|
890
|
+
* key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
|
|
891
|
+
*/
|
|
892
|
+
keySet?: KeySet;
|
|
893
|
+
/** Additional options that affect how many partitions are created. */
|
|
894
|
+
partitionOptions?: PartitionOptions;
|
|
895
|
+
/** Required. The name of the table in the database to be read. */
|
|
896
|
+
table?: string;
|
|
897
|
+
/** Read only snapshot transactions are supported, read/write and single use transactions are not. */
|
|
898
|
+
transaction?: TransactionSelector;
|
|
899
|
+
}
|
|
900
|
+
interface PartitionResponse {
|
|
901
|
+
/** Partitions created by this request. */
|
|
902
|
+
partitions?: Partition[];
|
|
903
|
+
/** Transaction created by this request. */
|
|
904
|
+
transaction?: Transaction;
|
|
905
|
+
}
|
|
906
|
+
interface PlanNode {
|
|
907
|
+
/** List of child node `index`es and their relationship to this parent. */
|
|
908
|
+
childLinks?: ChildLink[];
|
|
909
|
+
/** The display name for the node. */
|
|
910
|
+
displayName?: string;
|
|
911
|
+
/**
|
|
912
|
+
* The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number
|
|
913
|
+
* of executions, number of rows/time per execution etc.
|
|
914
|
+
*/
|
|
915
|
+
executionStats?: { [P in string]: any };
|
|
916
|
+
/** The `PlanNode`'s index in node list. */
|
|
917
|
+
index?: number;
|
|
918
|
+
/**
|
|
919
|
+
* Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed
|
|
920
|
+
* representation which can be used to directly embed a description of the node in its parent.
|
|
921
|
+
*/
|
|
922
|
+
kind?: string;
|
|
923
|
+
/**
|
|
924
|
+
* Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: {
|
|
925
|
+
* "parameter_reference": "param1", "parameter_type": "array" }
|
|
926
|
+
*/
|
|
927
|
+
metadata?: { [P in string]: any };
|
|
928
|
+
/** Condensed representation for SCALAR nodes. */
|
|
929
|
+
shortRepresentation?: ShortRepresentation;
|
|
930
|
+
}
|
|
931
|
+
interface Policy {
|
|
932
|
+
/**
|
|
933
|
+
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
|
|
934
|
+
* must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
|
|
935
|
+
* principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
|
|
936
|
+
* 1,450 principals to the `bindings` in the `Policy`.
|
|
937
|
+
*/
|
|
938
|
+
bindings?: Binding[];
|
|
939
|
+
/**
|
|
940
|
+
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make
|
|
941
|
+
* use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems
|
|
942
|
+
* are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM
|
|
943
|
+
* Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
944
|
+
* policy, and all of the conditions in the version `3` policy are lost.
|
|
945
|
+
*/
|
|
946
|
+
etag?: string;
|
|
947
|
+
/**
|
|
948
|
+
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
|
|
949
|
+
* must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
|
|
950
|
+
* policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
|
|
951
|
+
* IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
952
|
+
* policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
|
|
953
|
+
* the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
954
|
+
*/
|
|
955
|
+
version?: number;
|
|
956
|
+
}
|
|
957
|
+
interface PrefixNode {
|
|
958
|
+
/** Whether this corresponds to a data_source name. */
|
|
959
|
+
dataSourceNode?: boolean;
|
|
960
|
+
/** The depth in the prefix hierarchy. */
|
|
961
|
+
depth?: number;
|
|
962
|
+
/** The index of the end key bucket of the range that this node spans. */
|
|
963
|
+
endIndex?: number;
|
|
964
|
+
/** The index of the start key bucket of the range that this node spans. */
|
|
965
|
+
startIndex?: number;
|
|
966
|
+
/** The string represented by the prefix node. */
|
|
967
|
+
word?: string;
|
|
968
|
+
}
|
|
969
|
+
interface QueryOptions {
|
|
970
|
+
/**
|
|
971
|
+
* An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying
|
|
972
|
+
* `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level
|
|
973
|
+
* options, or the latest package if the database option is not set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with
|
|
974
|
+
* the following DDL statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from
|
|
975
|
+
* `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails
|
|
976
|
+
* with an `INVALID_ARGUMENT` error.
|
|
977
|
+
*/
|
|
978
|
+
optimizerStatisticsPackage?: string;
|
|
979
|
+
/**
|
|
980
|
+
* An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value
|
|
981
|
+
* instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other
|
|
982
|
+
* positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried
|
|
983
|
+
* from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See
|
|
984
|
+
* https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has
|
|
985
|
+
* precedence over this setting.
|
|
986
|
+
*/
|
|
987
|
+
optimizerVersion?: string;
|
|
988
|
+
}
|
|
989
|
+
interface QueryPlan {
|
|
990
|
+
/** The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`. */
|
|
991
|
+
planNodes?: PlanNode[];
|
|
992
|
+
}
|
|
993
|
+
interface ReadOnly {
|
|
994
|
+
/**
|
|
995
|
+
* Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the
|
|
996
|
+
* specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud
|
|
997
|
+
* Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`.
|
|
998
|
+
*/
|
|
999
|
+
exactStaleness?: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud
|
|
1002
|
+
* Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading the freshest
|
|
1003
|
+
* data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind. Note that this option can only be used in single-use transactions.
|
|
1004
|
+
*/
|
|
1005
|
+
maxStaleness?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* 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
|
|
1008
|
+
* 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,
|
|
1009
|
+
* accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
|
|
1010
|
+
*/
|
|
1011
|
+
minReadTimestamp?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* 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
|
|
1014
|
+
* timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for
|
|
1015
|
+
* 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"`.
|
|
1016
|
+
*/
|
|
1017
|
+
readTimestamp?: string;
|
|
1018
|
+
/** If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction. */
|
|
1019
|
+
returnReadTimestamp?: boolean;
|
|
1020
|
+
/** Read at a timestamp where all previously committed transactions are visible. */
|
|
1021
|
+
strong?: boolean;
|
|
1022
|
+
}
|
|
1023
|
+
interface ReadRequest {
|
|
1024
|
+
/** Required. The columns of table to be returned for each row matching this request. */
|
|
1025
|
+
columns?: string[];
|
|
1026
|
+
/**
|
|
1027
|
+
* If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further
|
|
1028
|
+
* information.
|
|
1029
|
+
*/
|
|
1030
|
+
index?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then
|
|
1033
|
+
* key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is
|
|
1034
|
+
* non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the
|
|
1035
|
+
* database. Read yields nothing for nonexistent rows.
|
|
1036
|
+
*/
|
|
1037
|
+
keySet?: KeySet;
|
|
1038
|
+
/** If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set. */
|
|
1039
|
+
limit?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this
|
|
1042
|
+
* message and the PartitionReadRequest message used to create this partition_token.
|
|
1043
|
+
*/
|
|
1044
|
+
partitionToken?: string;
|
|
1045
|
+
/** Common options for this request. */
|
|
1046
|
+
requestOptions?: RequestOptions;
|
|
1047
|
+
/**
|
|
1048
|
+
* If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new
|
|
1049
|
+
* read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.
|
|
1050
|
+
*/
|
|
1051
|
+
resumeToken?: string;
|
|
1052
|
+
/** Required. The name of the table in the database to be read. */
|
|
1053
|
+
table?: string;
|
|
1054
|
+
/** The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. */
|
|
1055
|
+
transaction?: TransactionSelector;
|
|
1056
|
+
}
|
|
1057
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1058
|
+
interface ReadWrite {
|
|
1059
|
+
}
|
|
1060
|
+
interface ReplicaInfo {
|
|
1061
|
+
/**
|
|
1062
|
+
* If true, this location is designated as the default leader location where leader replicas are placed. See the [region types
|
|
1063
|
+
* documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
|
|
1064
|
+
*/
|
|
1065
|
+
defaultLeaderLocation?: boolean;
|
|
1066
|
+
/** The location of the serving resources, e.g. "us-central1". */
|
|
1067
|
+
location?: string;
|
|
1068
|
+
/** The type of replica. */
|
|
1069
|
+
type?: string;
|
|
1070
|
+
}
|
|
1071
|
+
interface RequestOptions {
|
|
1072
|
+
/** Priority for the request. */
|
|
1073
|
+
priority?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to
|
|
1076
|
+
* a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 -
|
|
1077
|
+
* 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.
|
|
1078
|
+
*/
|
|
1079
|
+
requestTag?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of
|
|
1082
|
+
* transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal
|
|
1083
|
+
* characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit
|
|
1084
|
+
* are truncated. Any leading underscore (_) characters will be removed from the string.
|
|
1085
|
+
*/
|
|
1086
|
+
transactionTag?: string;
|
|
1087
|
+
}
|
|
1088
|
+
interface RestoreDatabaseEncryptionConfig {
|
|
1089
|
+
/** Required. The encryption type of the restored database. */
|
|
1090
|
+
encryptionType?: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* 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
|
|
1093
|
+
* are of the form `projects//locations//keyRings//cryptoKeys/`.
|
|
1094
|
+
*/
|
|
1095
|
+
kmsKeyName?: string;
|
|
1096
|
+
}
|
|
1097
|
+
interface RestoreDatabaseMetadata {
|
|
1098
|
+
/** Information about the backup used to restore the database. */
|
|
1099
|
+
backupInfo?: BackupInfo;
|
|
1100
|
+
/**
|
|
1101
|
+
* The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best
|
|
1102
|
+
* effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
1103
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
1104
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
1105
|
+
*/
|
|
1106
|
+
cancelTime?: string;
|
|
1107
|
+
/** Name of the database being created and restored to. */
|
|
1108
|
+
name?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove
|
|
1111
|
+
* the dependency on the restore source. The name is of the form `projects//instances//databases//operations/` where the is the name of database being created and restored to. The
|
|
1112
|
+
* metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase
|
|
1113
|
+
* long-running operation completes successfully. This operation will not be created if the restore was not successful.
|
|
1114
|
+
*/
|
|
1115
|
+
optimizeDatabaseOperationName?: string;
|
|
1116
|
+
/** The progress of the RestoreDatabase operation. */
|
|
1117
|
+
progress?: OperationProgress;
|
|
1118
|
+
/** The type of the restore source. */
|
|
1119
|
+
sourceType?: string;
|
|
1120
|
+
}
|
|
1121
|
+
interface RestoreDatabaseRequest {
|
|
1122
|
+
/** Name of the backup from which to restore. Values are of the form `projects//instances//backups/`. */
|
|
1123
|
+
backup?: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form
|
|
1126
|
+
* `projects//instances//databases/`.
|
|
1127
|
+
*/
|
|
1128
|
+
databaseId?: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not
|
|
1131
|
+
* specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
|
|
1132
|
+
*/
|
|
1133
|
+
encryptionConfig?: RestoreDatabaseEncryptionConfig;
|
|
1134
|
+
}
|
|
1135
|
+
interface RestoreInfo {
|
|
1136
|
+
/** Information about the backup used to restore the database. The backup may no longer exist. */
|
|
1137
|
+
backupInfo?: BackupInfo;
|
|
1138
|
+
/** The type of the restore source. */
|
|
1139
|
+
sourceType?: string;
|
|
1140
|
+
}
|
|
1141
|
+
interface ResultSet {
|
|
1142
|
+
/** Metadata about the result set, such as row type information. */
|
|
1143
|
+
metadata?: ResultSetMetadata;
|
|
1144
|
+
/**
|
|
1145
|
+
* Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on
|
|
1146
|
+
* type as described here.
|
|
1147
|
+
*/
|
|
1148
|
+
rows?: any[][];
|
|
1149
|
+
/**
|
|
1150
|
+
* Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always
|
|
1151
|
+
* produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be
|
|
1152
|
+
* populated, based on the ExecuteSqlRequest.query_mode.
|
|
1153
|
+
*/
|
|
1154
|
+
stats?: ResultSetStats;
|
|
1155
|
+
}
|
|
1156
|
+
interface ResultSetMetadata {
|
|
1157
|
+
/**
|
|
1158
|
+
* Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like:
|
|
1159
|
+
* "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]
|
|
1160
|
+
*/
|
|
1161
|
+
rowType?: StructType;
|
|
1162
|
+
/** If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here. */
|
|
1163
|
+
transaction?: Transaction;
|
|
1164
|
+
}
|
|
1165
|
+
interface ResultSetStats {
|
|
1166
|
+
/** QueryPlan for the query associated with this result. */
|
|
1167
|
+
queryPlan?: QueryPlan;
|
|
1168
|
+
/**
|
|
1169
|
+
* Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3",
|
|
1170
|
+
* "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
|
|
1171
|
+
*/
|
|
1172
|
+
queryStats?: { [P in string]: any };
|
|
1173
|
+
/** Standard DML returns an exact count of rows that were modified. */
|
|
1174
|
+
rowCountExact?: string;
|
|
1175
|
+
/** Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. */
|
|
1176
|
+
rowCountLowerBound?: string;
|
|
1177
|
+
}
|
|
1178
|
+
interface RollbackRequest {
|
|
1179
|
+
/** Required. The transaction to roll back. */
|
|
1180
|
+
transactionId?: string;
|
|
1181
|
+
}
|
|
1182
|
+
interface Scan {
|
|
1183
|
+
/** Additional information provided by the implementer. */
|
|
1184
|
+
details?: { [P in string]: any };
|
|
1185
|
+
/** The upper bound for when the scan is defined. */
|
|
1186
|
+
endTime?: string;
|
|
1187
|
+
/** The unique name of the scan, specific to the Database service implementing this interface. */
|
|
1188
|
+
name?: string;
|
|
1189
|
+
/** Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans method. */
|
|
1190
|
+
scanData?: ScanData;
|
|
1191
|
+
/** A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined. */
|
|
1192
|
+
startTime?: string;
|
|
1193
|
+
}
|
|
1194
|
+
interface ScanData {
|
|
1195
|
+
/** Cloud Key Visualizer scan data. The range of time this information covers is captured via the above time range fields. Note, this field is not available to the ListScans method. */
|
|
1196
|
+
data?: VisualizationData;
|
|
1197
|
+
/** The upper bound for when the contained data is defined. */
|
|
1198
|
+
endTime?: string;
|
|
1199
|
+
/** A range of time (inclusive) for when the contained data is defined. The lower bound for when the contained data is defined. */
|
|
1200
|
+
startTime?: string;
|
|
1201
|
+
}
|
|
1202
|
+
interface Session {
|
|
1203
|
+
/** Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. */
|
|
1204
|
+
approximateLastUseTime?: string;
|
|
1205
|
+
/** Output only. The timestamp when the session is created. */
|
|
1206
|
+
createTime?: string;
|
|
1207
|
+
/** The database role which created this session. */
|
|
1208
|
+
creatorRole?: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values
|
|
1211
|
+
* must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session.
|
|
1212
|
+
* See https://goo.gl/xmQnxf for more information on and examples of labels.
|
|
1213
|
+
*/
|
|
1214
|
+
labels?: { [P in string]: string };
|
|
1215
|
+
/** Output only. The name of the session. This is always system-assigned. */
|
|
1216
|
+
name?: string;
|
|
1217
|
+
}
|
|
1218
|
+
interface SetIamPolicyRequest {
|
|
1219
|
+
/**
|
|
1220
|
+
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
|
|
1221
|
+
* services (such as Projects) might reject them.
|
|
1222
|
+
*/
|
|
1223
|
+
policy?: Policy;
|
|
1224
|
+
}
|
|
1225
|
+
interface ShortRepresentation {
|
|
1226
|
+
/** A string representation of the expression subtree rooted at this node. */
|
|
1227
|
+
description?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree
|
|
1230
|
+
* rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node.
|
|
1231
|
+
*/
|
|
1232
|
+
subqueries?: { [P in string]: number };
|
|
1233
|
+
}
|
|
1234
|
+
interface Statement {
|
|
1235
|
+
/**
|
|
1236
|
+
* Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example,
|
|
1237
|
+
* `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used
|
|
1238
|
+
* more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
|
|
1239
|
+
*/
|
|
1240
|
+
params?: { [P in string]: any };
|
|
1241
|
+
/**
|
|
1242
|
+
* It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as
|
|
1243
|
+
* JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more
|
|
1244
|
+
* information about SQL types.
|
|
1245
|
+
*/
|
|
1246
|
+
paramTypes?: { [P in string]: Type };
|
|
1247
|
+
/** Required. The DML string. */
|
|
1248
|
+
sql?: string;
|
|
1249
|
+
}
|
|
1250
|
+
interface Status {
|
|
1251
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1252
|
+
code?: number;
|
|
1253
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1254
|
+
details?: Array<{ [P in string]: any }>;
|
|
1255
|
+
/**
|
|
1256
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
1257
|
+
* client.
|
|
1258
|
+
*/
|
|
1259
|
+
message?: string;
|
|
1260
|
+
}
|
|
1261
|
+
interface StructType {
|
|
1262
|
+
/**
|
|
1263
|
+
* The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of
|
|
1264
|
+
* fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
|
|
1265
|
+
*/
|
|
1266
|
+
fields?: Field[];
|
|
1267
|
+
}
|
|
1268
|
+
interface TestIamPermissionsRequest {
|
|
1269
|
+
/** REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed. */
|
|
1270
|
+
permissions?: string[];
|
|
1271
|
+
}
|
|
1272
|
+
interface TestIamPermissionsResponse {
|
|
1273
|
+
/** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
|
|
1274
|
+
permissions?: string[];
|
|
1275
|
+
}
|
|
1276
|
+
interface Transaction {
|
|
1277
|
+
/**
|
|
1278
|
+
* `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
|
|
1279
|
+
* transactions do not support multiple requests.
|
|
1280
|
+
*/
|
|
1281
|
+
id?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* 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
|
|
1284
|
+
* RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
|
|
1285
|
+
*/
|
|
1286
|
+
readTimestamp?: string;
|
|
1287
|
+
}
|
|
1288
|
+
interface TransactionOptions {
|
|
1289
|
+
/** Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */
|
|
1290
|
+
partitionedDml?: any;
|
|
1291
|
+
/** Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. */
|
|
1292
|
+
readOnly?: ReadOnly;
|
|
1293
|
+
/** Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. */
|
|
1294
|
+
readWrite?: any;
|
|
1295
|
+
}
|
|
1296
|
+
interface TransactionSelector {
|
|
1297
|
+
/** Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction. */
|
|
1298
|
+
begin?: TransactionOptions;
|
|
1299
|
+
/** Execute the read or SQL query in a previously-started transaction. */
|
|
1300
|
+
id?: string;
|
|
1301
|
+
/** Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query. */
|
|
1302
|
+
singleUse?: TransactionOptions;
|
|
1303
|
+
}
|
|
1304
|
+
interface Type {
|
|
1305
|
+
/** If code == ARRAY, then `array_element_type` is the type of the array elements. */
|
|
1306
|
+
arrayElementType?: Type;
|
|
1307
|
+
/** Required. The TypeCode for this type. */
|
|
1308
|
+
code?: string;
|
|
1309
|
+
/** If code == STRUCT, then `struct_type` provides type information for the struct's fields. */
|
|
1310
|
+
structType?: StructType;
|
|
1311
|
+
/**
|
|
1312
|
+
* The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a
|
|
1313
|
+
* single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect
|
|
1314
|
+
* serialization) and clients can ignore it on the read path.
|
|
1315
|
+
*/
|
|
1316
|
+
typeAnnotation?: string;
|
|
1317
|
+
}
|
|
1318
|
+
interface UpdateDatabaseDdlMetadata {
|
|
1319
|
+
/** Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`. */
|
|
1320
|
+
commitTimestamps?: string[];
|
|
1321
|
+
/** The database being modified. */
|
|
1322
|
+
database?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements,
|
|
1325
|
+
* `progress[i]` will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. `progress[i]` is the
|
|
1326
|
+
* operation progress for `statements[i]`.
|
|
1327
|
+
*/
|
|
1328
|
+
progress?: OperationProgress[];
|
|
1329
|
+
/** For an update this list contains all the statements. For an individual statement, this list contains only that statement. */
|
|
1330
|
+
statements?: string[];
|
|
1331
|
+
/**
|
|
1332
|
+
* 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
|
|
1333
|
+
* false again.
|
|
1334
|
+
*/
|
|
1335
|
+
throttled?: boolean;
|
|
1336
|
+
}
|
|
1337
|
+
interface UpdateDatabaseDdlRequest {
|
|
1338
|
+
/**
|
|
1339
|
+
* If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying
|
|
1340
|
+
* an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost:
|
|
1341
|
+
* the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database,
|
|
1342
|
+
* and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl
|
|
1343
|
+
* returns `ALREADY_EXISTS`.
|
|
1344
|
+
*/
|
|
1345
|
+
operationId?: string;
|
|
1346
|
+
/** Required. DDL statements to be applied to the database. */
|
|
1347
|
+
statements?: string[];
|
|
1348
|
+
}
|
|
1349
|
+
interface UpdateInstanceMetadata {
|
|
1350
|
+
/** The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */
|
|
1351
|
+
cancelTime?: string;
|
|
1352
|
+
/** The time at which this operation failed or was completed successfully. */
|
|
1353
|
+
endTime?: string;
|
|
1354
|
+
/** The desired end state of the update. */
|
|
1355
|
+
instance?: Instance;
|
|
1356
|
+
/** The time at which UpdateInstance request was received. */
|
|
1357
|
+
startTime?: string;
|
|
1358
|
+
}
|
|
1359
|
+
interface UpdateInstanceRequest {
|
|
1360
|
+
/**
|
|
1361
|
+
* Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased
|
|
1362
|
+
* accidentally by clients that do not know about them.
|
|
1363
|
+
*/
|
|
1364
|
+
fieldMask?: string;
|
|
1365
|
+
/** Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. */
|
|
1366
|
+
instance?: Instance;
|
|
1367
|
+
}
|
|
1368
|
+
interface VisualizationData {
|
|
1369
|
+
/** The token signifying the end of a data_source. */
|
|
1370
|
+
dataSourceEndToken?: string;
|
|
1371
|
+
/** The token delimiting a datasource name from the rest of a key in a data_source. */
|
|
1372
|
+
dataSourceSeparatorToken?: string;
|
|
1373
|
+
/** The list of messages (info, alerts, ...) */
|
|
1374
|
+
diagnosticMessages?: DiagnosticMessage[];
|
|
1375
|
+
/**
|
|
1376
|
+
* We discretize the entire keyspace into buckets. Assuming each bucket has an inclusive keyrange and covers keys from k(i) ... k(n). In this case k(n) would be an end key for a given
|
|
1377
|
+
* range. end_key_string is the collection of all such end keys
|
|
1378
|
+
*/
|
|
1379
|
+
endKeyStrings?: string[];
|
|
1380
|
+
/** Whether this scan contains PII. */
|
|
1381
|
+
hasPii?: boolean;
|
|
1382
|
+
/** Keys of key ranges that contribute significantly to a given metric Can be thought of as heavy hitters. */
|
|
1383
|
+
indexedKeys?: string[];
|
|
1384
|
+
/** The token delimiting the key prefixes. */
|
|
1385
|
+
keySeparator?: string;
|
|
1386
|
+
/** The unit for the key: e.g. 'key' or 'chunk'. */
|
|
1387
|
+
keyUnit?: string;
|
|
1388
|
+
/** The list of data objects for each metric. */
|
|
1389
|
+
metrics?: Metric[];
|
|
1390
|
+
/** The list of extracted key prefix nodes used in the key prefix hierarchy. */
|
|
1391
|
+
prefixNodes?: PrefixNode[];
|
|
1392
|
+
}
|
|
1393
|
+
interface Write {
|
|
1394
|
+
/**
|
|
1395
|
+
* The names of the columns in table to be written. The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to
|
|
1396
|
+
* be modified.
|
|
1397
|
+
*/
|
|
1398
|
+
columns?: string[];
|
|
1399
|
+
/** Required. The table whose rows will be written. */
|
|
1400
|
+
table?: string;
|
|
1401
|
+
/**
|
|
1402
|
+
* The values to be written. `values` can contain more than one list of values. If it does, then multiple rows are written, one for each entry in `values`. Each list in `values` must
|
|
1403
|
+
* have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple `Mutation`s, each containing one `values` entry and
|
|
1404
|
+
* repeating table and columns. Individual values in each list are encoded as described here.
|
|
1405
|
+
*/
|
|
1406
|
+
values?: any[][];
|
|
1407
|
+
}
|
|
1408
|
+
interface OperationsResource {
|
|
1409
|
+
/**
|
|
1410
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
1411
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
1412
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
1413
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
1414
|
+
*/
|
|
1415
|
+
cancel(request?: {
|
|
1416
|
+
/** V1 error format. */
|
|
1417
|
+
"$.xgafv"?: string;
|
|
1418
|
+
/** OAuth access token. */
|
|
1419
|
+
access_token?: string;
|
|
1420
|
+
/** Data format for response. */
|
|
1421
|
+
alt?: string;
|
|
1422
|
+
/** JSONP */
|
|
1423
|
+
callback?: string;
|
|
1424
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1425
|
+
fields?: string;
|
|
1426
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1427
|
+
key?: string;
|
|
1428
|
+
/** The name of the operation resource to be cancelled. */
|
|
1429
|
+
name: string;
|
|
1430
|
+
/** OAuth 2.0 token for the current user. */
|
|
1431
|
+
oauth_token?: string;
|
|
1432
|
+
/** Returns response with indentations and line breaks. */
|
|
1433
|
+
prettyPrint?: boolean;
|
|
1434
|
+
/** 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. */
|
|
1435
|
+
quotaUser?: string;
|
|
1436
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1437
|
+
upload_protocol?: string;
|
|
1438
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1439
|
+
uploadType?: string;
|
|
1440
|
+
}): Request<{}>;
|
|
1441
|
+
/**
|
|
1442
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
|
|
1443
|
+
* support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
1444
|
+
*/
|
|
1445
|
+
delete(request?: {
|
|
1446
|
+
/** V1 error format. */
|
|
1447
|
+
"$.xgafv"?: string;
|
|
1448
|
+
/** OAuth access token. */
|
|
1449
|
+
access_token?: string;
|
|
1450
|
+
/** Data format for response. */
|
|
1451
|
+
alt?: string;
|
|
1452
|
+
/** JSONP */
|
|
1453
|
+
callback?: string;
|
|
1454
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1455
|
+
fields?: string;
|
|
1456
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1457
|
+
key?: string;
|
|
1458
|
+
/** The name of the operation resource to be deleted. */
|
|
1459
|
+
name: string;
|
|
1460
|
+
/** OAuth 2.0 token for the current user. */
|
|
1461
|
+
oauth_token?: string;
|
|
1462
|
+
/** Returns response with indentations and line breaks. */
|
|
1463
|
+
prettyPrint?: boolean;
|
|
1464
|
+
/** 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. */
|
|
1465
|
+
quotaUser?: string;
|
|
1466
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1467
|
+
upload_protocol?: string;
|
|
1468
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1469
|
+
uploadType?: string;
|
|
1470
|
+
}): Request<{}>;
|
|
1471
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1472
|
+
get(request?: {
|
|
1473
|
+
/** V1 error format. */
|
|
1474
|
+
"$.xgafv"?: string;
|
|
1475
|
+
/** OAuth access token. */
|
|
1476
|
+
access_token?: string;
|
|
1477
|
+
/** Data format for response. */
|
|
1478
|
+
alt?: string;
|
|
1479
|
+
/** JSONP */
|
|
1480
|
+
callback?: string;
|
|
1481
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1482
|
+
fields?: string;
|
|
1483
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1484
|
+
key?: string;
|
|
1485
|
+
/** The name of the operation resource. */
|
|
1486
|
+
name: string;
|
|
1487
|
+
/** OAuth 2.0 token for the current user. */
|
|
1488
|
+
oauth_token?: string;
|
|
1489
|
+
/** Returns response with indentations and line breaks. */
|
|
1490
|
+
prettyPrint?: boolean;
|
|
1491
|
+
/** 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. */
|
|
1492
|
+
quotaUser?: string;
|
|
1493
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1494
|
+
upload_protocol?: string;
|
|
1495
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1496
|
+
uploadType?: string;
|
|
1497
|
+
}): Request<Operation>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
1500
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
1501
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
1502
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
1503
|
+
*/
|
|
1504
|
+
list(request?: {
|
|
1505
|
+
/** V1 error format. */
|
|
1506
|
+
"$.xgafv"?: string;
|
|
1507
|
+
/** OAuth access token. */
|
|
1508
|
+
access_token?: string;
|
|
1509
|
+
/** Data format for response. */
|
|
1510
|
+
alt?: string;
|
|
1511
|
+
/** JSONP */
|
|
1512
|
+
callback?: string;
|
|
1513
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1514
|
+
fields?: string;
|
|
1515
|
+
/** The standard list filter. */
|
|
1516
|
+
filter?: string;
|
|
1517
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1518
|
+
key?: string;
|
|
1519
|
+
/** The name of the operation's parent resource. */
|
|
1520
|
+
name: string;
|
|
1521
|
+
/** OAuth 2.0 token for the current user. */
|
|
1522
|
+
oauth_token?: string;
|
|
1523
|
+
/** The standard list page size. */
|
|
1524
|
+
pageSize?: number;
|
|
1525
|
+
/** The standard list page token. */
|
|
1526
|
+
pageToken?: string;
|
|
1527
|
+
/** Returns response with indentations and line breaks. */
|
|
1528
|
+
prettyPrint?: boolean;
|
|
1529
|
+
/** 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. */
|
|
1530
|
+
quotaUser?: string;
|
|
1531
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1532
|
+
upload_protocol?: string;
|
|
1533
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1534
|
+
uploadType?: string;
|
|
1535
|
+
}): Request<ListOperationsResponse>;
|
|
1536
|
+
}
|
|
1537
|
+
interface InstanceConfigsResource {
|
|
1538
|
+
/** Gets information about a particular instance configuration. */
|
|
1539
|
+
get(request?: {
|
|
1540
|
+
/** V1 error format. */
|
|
1541
|
+
"$.xgafv"?: string;
|
|
1542
|
+
/** OAuth access token. */
|
|
1543
|
+
access_token?: string;
|
|
1544
|
+
/** Data format for response. */
|
|
1545
|
+
alt?: string;
|
|
1546
|
+
/** JSONP */
|
|
1547
|
+
callback?: string;
|
|
1548
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1549
|
+
fields?: string;
|
|
1550
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1551
|
+
key?: string;
|
|
1552
|
+
/** Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`. */
|
|
1553
|
+
name: string;
|
|
1554
|
+
/** OAuth 2.0 token for the current user. */
|
|
1555
|
+
oauth_token?: string;
|
|
1556
|
+
/** Returns response with indentations and line breaks. */
|
|
1557
|
+
prettyPrint?: boolean;
|
|
1558
|
+
/** 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. */
|
|
1559
|
+
quotaUser?: string;
|
|
1560
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1561
|
+
upload_protocol?: string;
|
|
1562
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1563
|
+
uploadType?: string;
|
|
1564
|
+
}): Request<InstanceConfig>;
|
|
1565
|
+
/** Lists the supported instance configurations for a given project. */
|
|
1566
|
+
list(request?: {
|
|
1567
|
+
/** V1 error format. */
|
|
1568
|
+
"$.xgafv"?: string;
|
|
1569
|
+
/** OAuth access token. */
|
|
1570
|
+
access_token?: string;
|
|
1571
|
+
/** Data format for response. */
|
|
1572
|
+
alt?: string;
|
|
1573
|
+
/** JSONP */
|
|
1574
|
+
callback?: string;
|
|
1575
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1576
|
+
fields?: string;
|
|
1577
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1578
|
+
key?: string;
|
|
1579
|
+
/** OAuth 2.0 token for the current user. */
|
|
1580
|
+
oauth_token?: string;
|
|
1581
|
+
/** Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
1582
|
+
pageSize?: number;
|
|
1583
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse. */
|
|
1584
|
+
pageToken?: string;
|
|
1585
|
+
/** Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. */
|
|
1586
|
+
parent: string;
|
|
1587
|
+
/** Returns response with indentations and line breaks. */
|
|
1588
|
+
prettyPrint?: boolean;
|
|
1589
|
+
/** 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. */
|
|
1590
|
+
quotaUser?: string;
|
|
1591
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1592
|
+
upload_protocol?: string;
|
|
1593
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1594
|
+
uploadType?: string;
|
|
1595
|
+
}): Request<ListInstanceConfigsResponse>;
|
|
1596
|
+
operations: OperationsResource;
|
|
1597
|
+
}
|
|
1598
|
+
interface BackupOperationsResource {
|
|
1599
|
+
/**
|
|
1600
|
+
* Lists the backup long-running operations in the given instance. A backup operation has a name of the form `projects//instances//backups//operations/`. The long-running operation
|
|
1601
|
+
* metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending
|
|
1602
|
+
* operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.
|
|
1603
|
+
*/
|
|
1604
|
+
list(request?: {
|
|
1605
|
+
/** V1 error format. */
|
|
1606
|
+
"$.xgafv"?: string;
|
|
1607
|
+
/** OAuth access token. */
|
|
1608
|
+
access_token?: string;
|
|
1609
|
+
/** Data format for response. */
|
|
1610
|
+
alt?: string;
|
|
1611
|
+
/** JSONP */
|
|
1612
|
+
callback?: string;
|
|
1613
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1614
|
+
fields?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must
|
|
1617
|
+
* be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not
|
|
1618
|
+
* case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in
|
|
1619
|
+
* progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is
|
|
1620
|
+
* `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering
|
|
1621
|
+
* on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You
|
|
1622
|
+
* can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic
|
|
1623
|
+
* explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata)
|
|
1624
|
+
* AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string
|
|
1625
|
+
* "prod". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time <
|
|
1626
|
+
* \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". *
|
|
1627
|
+
* The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. *
|
|
1628
|
+
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time <
|
|
1629
|
+
* \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string
|
|
1630
|
+
* "test". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. *
|
|
1631
|
+
* `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.database:test_db)) OR` \
|
|
1632
|
+
* `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations
|
|
1633
|
+
* where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the
|
|
1634
|
+
* string "test_db" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp" * The operation resulted in an error.
|
|
1635
|
+
*/
|
|
1636
|
+
filter?: string;
|
|
1637
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1638
|
+
key?: string;
|
|
1639
|
+
/** OAuth 2.0 token for the current user. */
|
|
1640
|
+
oauth_token?: string;
|
|
1641
|
+
/** Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
1642
|
+
pageSize?: number;
|
|
1643
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`. */
|
|
1644
|
+
pageToken?: string;
|
|
1645
|
+
/** Required. The instance of the backup operations. Values are of the form `projects//instances/`. */
|
|
1646
|
+
parent: string;
|
|
1647
|
+
/** Returns response with indentations and line breaks. */
|
|
1648
|
+
prettyPrint?: boolean;
|
|
1649
|
+
/** 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. */
|
|
1650
|
+
quotaUser?: string;
|
|
1651
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1652
|
+
upload_protocol?: string;
|
|
1653
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1654
|
+
uploadType?: string;
|
|
1655
|
+
}): Request<ListBackupOperationsResponse>;
|
|
1656
|
+
}
|
|
1657
|
+
interface OperationsResource {
|
|
1658
|
+
/**
|
|
1659
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
1660
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
1661
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
1662
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
1663
|
+
*/
|
|
1664
|
+
cancel(request?: {
|
|
1665
|
+
/** V1 error format. */
|
|
1666
|
+
"$.xgafv"?: string;
|
|
1667
|
+
/** OAuth access token. */
|
|
1668
|
+
access_token?: string;
|
|
1669
|
+
/** Data format for response. */
|
|
1670
|
+
alt?: string;
|
|
1671
|
+
/** JSONP */
|
|
1672
|
+
callback?: string;
|
|
1673
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1674
|
+
fields?: string;
|
|
1675
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1676
|
+
key?: string;
|
|
1677
|
+
/** The name of the operation resource to be cancelled. */
|
|
1678
|
+
name: string;
|
|
1679
|
+
/** OAuth 2.0 token for the current user. */
|
|
1680
|
+
oauth_token?: string;
|
|
1681
|
+
/** Returns response with indentations and line breaks. */
|
|
1682
|
+
prettyPrint?: boolean;
|
|
1683
|
+
/** 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. */
|
|
1684
|
+
quotaUser?: string;
|
|
1685
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1686
|
+
upload_protocol?: string;
|
|
1687
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1688
|
+
uploadType?: string;
|
|
1689
|
+
}): Request<{}>;
|
|
1690
|
+
/**
|
|
1691
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
|
|
1692
|
+
* support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
1693
|
+
*/
|
|
1694
|
+
delete(request?: {
|
|
1695
|
+
/** V1 error format. */
|
|
1696
|
+
"$.xgafv"?: string;
|
|
1697
|
+
/** OAuth access token. */
|
|
1698
|
+
access_token?: string;
|
|
1699
|
+
/** Data format for response. */
|
|
1700
|
+
alt?: string;
|
|
1701
|
+
/** JSONP */
|
|
1702
|
+
callback?: string;
|
|
1703
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1704
|
+
fields?: string;
|
|
1705
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1706
|
+
key?: string;
|
|
1707
|
+
/** The name of the operation resource to be deleted. */
|
|
1708
|
+
name: string;
|
|
1709
|
+
/** OAuth 2.0 token for the current user. */
|
|
1710
|
+
oauth_token?: string;
|
|
1711
|
+
/** Returns response with indentations and line breaks. */
|
|
1712
|
+
prettyPrint?: boolean;
|
|
1713
|
+
/** 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. */
|
|
1714
|
+
quotaUser?: string;
|
|
1715
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1716
|
+
upload_protocol?: string;
|
|
1717
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1718
|
+
uploadType?: string;
|
|
1719
|
+
}): Request<{}>;
|
|
1720
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1721
|
+
get(request?: {
|
|
1722
|
+
/** V1 error format. */
|
|
1723
|
+
"$.xgafv"?: string;
|
|
1724
|
+
/** OAuth access token. */
|
|
1725
|
+
access_token?: string;
|
|
1726
|
+
/** Data format for response. */
|
|
1727
|
+
alt?: string;
|
|
1728
|
+
/** JSONP */
|
|
1729
|
+
callback?: string;
|
|
1730
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1731
|
+
fields?: string;
|
|
1732
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1733
|
+
key?: string;
|
|
1734
|
+
/** The name of the operation resource. */
|
|
1735
|
+
name: string;
|
|
1736
|
+
/** OAuth 2.0 token for the current user. */
|
|
1737
|
+
oauth_token?: string;
|
|
1738
|
+
/** Returns response with indentations and line breaks. */
|
|
1739
|
+
prettyPrint?: boolean;
|
|
1740
|
+
/** 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. */
|
|
1741
|
+
quotaUser?: string;
|
|
1742
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1743
|
+
upload_protocol?: string;
|
|
1744
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1745
|
+
uploadType?: string;
|
|
1746
|
+
}): Request<Operation>;
|
|
1747
|
+
/**
|
|
1748
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
1749
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
1750
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
1751
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
1752
|
+
*/
|
|
1753
|
+
list(request?: {
|
|
1754
|
+
/** V1 error format. */
|
|
1755
|
+
"$.xgafv"?: string;
|
|
1756
|
+
/** OAuth access token. */
|
|
1757
|
+
access_token?: string;
|
|
1758
|
+
/** Data format for response. */
|
|
1759
|
+
alt?: string;
|
|
1760
|
+
/** JSONP */
|
|
1761
|
+
callback?: string;
|
|
1762
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1763
|
+
fields?: string;
|
|
1764
|
+
/** The standard list filter. */
|
|
1765
|
+
filter?: string;
|
|
1766
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1767
|
+
key?: string;
|
|
1768
|
+
/** The name of the operation's parent resource. */
|
|
1769
|
+
name: string;
|
|
1770
|
+
/** OAuth 2.0 token for the current user. */
|
|
1771
|
+
oauth_token?: string;
|
|
1772
|
+
/** The standard list page size. */
|
|
1773
|
+
pageSize?: number;
|
|
1774
|
+
/** The standard list page token. */
|
|
1775
|
+
pageToken?: string;
|
|
1776
|
+
/** Returns response with indentations and line breaks. */
|
|
1777
|
+
prettyPrint?: boolean;
|
|
1778
|
+
/** 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. */
|
|
1779
|
+
quotaUser?: string;
|
|
1780
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1781
|
+
upload_protocol?: string;
|
|
1782
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1783
|
+
uploadType?: string;
|
|
1784
|
+
}): Request<ListOperationsResponse>;
|
|
1785
|
+
}
|
|
1786
|
+
interface BackupsResource {
|
|
1787
|
+
/**
|
|
1788
|
+
* Starts copying a 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
|
|
1789
|
+
* copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful.
|
|
1790
|
+
* Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.
|
|
1791
|
+
*/
|
|
1792
|
+
copy(request: {
|
|
1793
|
+
/** V1 error format. */
|
|
1794
|
+
"$.xgafv"?: string;
|
|
1795
|
+
/** OAuth access token. */
|
|
1796
|
+
access_token?: string;
|
|
1797
|
+
/** Data format for response. */
|
|
1798
|
+
alt?: string;
|
|
1799
|
+
/** JSONP */
|
|
1800
|
+
callback?: string;
|
|
1801
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1802
|
+
fields?: string;
|
|
1803
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1804
|
+
key?: string;
|
|
1805
|
+
/** OAuth 2.0 token for the current user. */
|
|
1806
|
+
oauth_token?: string;
|
|
1807
|
+
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`. */
|
|
1808
|
+
parent: string;
|
|
1809
|
+
/** Returns response with indentations and line breaks. */
|
|
1810
|
+
prettyPrint?: boolean;
|
|
1811
|
+
/** 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. */
|
|
1812
|
+
quotaUser?: string;
|
|
1813
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1814
|
+
upload_protocol?: string;
|
|
1815
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1816
|
+
uploadType?: string;
|
|
1817
|
+
/** Request body */
|
|
1818
|
+
resource: CopyBackupRequest;
|
|
1819
|
+
}): Request<Operation>;
|
|
1820
|
+
copy(request: {
|
|
1821
|
+
/** V1 error format. */
|
|
1822
|
+
"$.xgafv"?: string;
|
|
1823
|
+
/** OAuth access token. */
|
|
1824
|
+
access_token?: string;
|
|
1825
|
+
/** Data format for response. */
|
|
1826
|
+
alt?: string;
|
|
1827
|
+
/** JSONP */
|
|
1828
|
+
callback?: string;
|
|
1829
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1830
|
+
fields?: string;
|
|
1831
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1832
|
+
key?: string;
|
|
1833
|
+
/** OAuth 2.0 token for the current user. */
|
|
1834
|
+
oauth_token?: string;
|
|
1835
|
+
/** Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`. */
|
|
1836
|
+
parent: string;
|
|
1837
|
+
/** Returns response with indentations and line breaks. */
|
|
1838
|
+
prettyPrint?: boolean;
|
|
1839
|
+
/** 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. */
|
|
1840
|
+
quotaUser?: string;
|
|
1841
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1842
|
+
upload_protocol?: string;
|
|
1843
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1844
|
+
uploadType?: string;
|
|
1845
|
+
},
|
|
1846
|
+
body: CopyBackupRequest): Request<Operation>;
|
|
1847
|
+
/**
|
|
1848
|
+
* 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
|
|
1849
|
+
* 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
|
|
1850
|
+
* creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
|
|
1851
|
+
*/
|
|
1852
|
+
create(request: {
|
|
1853
|
+
/** V1 error format. */
|
|
1854
|
+
"$.xgafv"?: string;
|
|
1855
|
+
/** OAuth access token. */
|
|
1856
|
+
access_token?: string;
|
|
1857
|
+
/** Data format for response. */
|
|
1858
|
+
alt?: string;
|
|
1859
|
+
/** Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`. */
|
|
1860
|
+
backupId?: string;
|
|
1861
|
+
/** JSONP */
|
|
1862
|
+
callback?: string;
|
|
1863
|
+
/** Required. The encryption type of the backup. */
|
|
1864
|
+
"encryptionConfig.encryptionType"?: string;
|
|
1865
|
+
/**
|
|
1866
|
+
* 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
|
|
1867
|
+
* `projects//locations//keyRings//cryptoKeys/`.
|
|
1868
|
+
*/
|
|
1869
|
+
"encryptionConfig.kmsKeyName"?: string;
|
|
1870
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1871
|
+
fields?: string;
|
|
1872
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1873
|
+
key?: string;
|
|
1874
|
+
/** OAuth 2.0 token for the current user. */
|
|
1875
|
+
oauth_token?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* 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
|
|
1878
|
+
* will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.
|
|
1879
|
+
*/
|
|
1880
|
+
parent: string;
|
|
1881
|
+
/** Returns response with indentations and line breaks. */
|
|
1882
|
+
prettyPrint?: boolean;
|
|
1883
|
+
/** 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. */
|
|
1884
|
+
quotaUser?: string;
|
|
1885
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1886
|
+
upload_protocol?: string;
|
|
1887
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1888
|
+
uploadType?: string;
|
|
1889
|
+
/** Request body */
|
|
1890
|
+
resource: Backup;
|
|
1891
|
+
}): Request<Operation>;
|
|
1892
|
+
create(request: {
|
|
1893
|
+
/** V1 error format. */
|
|
1894
|
+
"$.xgafv"?: string;
|
|
1895
|
+
/** OAuth access token. */
|
|
1896
|
+
access_token?: string;
|
|
1897
|
+
/** Data format for response. */
|
|
1898
|
+
alt?: string;
|
|
1899
|
+
/** Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`. */
|
|
1900
|
+
backupId?: string;
|
|
1901
|
+
/** JSONP */
|
|
1902
|
+
callback?: string;
|
|
1903
|
+
/** Required. The encryption type of the backup. */
|
|
1904
|
+
"encryptionConfig.encryptionType"?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* 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
|
|
1907
|
+
* `projects//locations//keyRings//cryptoKeys/`.
|
|
1908
|
+
*/
|
|
1909
|
+
"encryptionConfig.kmsKeyName"?: string;
|
|
1910
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1911
|
+
fields?: string;
|
|
1912
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1913
|
+
key?: string;
|
|
1914
|
+
/** OAuth 2.0 token for the current user. */
|
|
1915
|
+
oauth_token?: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* 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
|
|
1918
|
+
* will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.
|
|
1919
|
+
*/
|
|
1920
|
+
parent: string;
|
|
1921
|
+
/** Returns response with indentations and line breaks. */
|
|
1922
|
+
prettyPrint?: boolean;
|
|
1923
|
+
/** 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. */
|
|
1924
|
+
quotaUser?: string;
|
|
1925
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1926
|
+
upload_protocol?: string;
|
|
1927
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1928
|
+
uploadType?: string;
|
|
1929
|
+
},
|
|
1930
|
+
body: Backup): Request<Operation>;
|
|
1931
|
+
/** Deletes a pending or completed Backup. */
|
|
1932
|
+
delete(request?: {
|
|
1933
|
+
/** V1 error format. */
|
|
1934
|
+
"$.xgafv"?: string;
|
|
1935
|
+
/** OAuth access token. */
|
|
1936
|
+
access_token?: string;
|
|
1937
|
+
/** Data format for response. */
|
|
1938
|
+
alt?: string;
|
|
1939
|
+
/** JSONP */
|
|
1940
|
+
callback?: string;
|
|
1941
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1942
|
+
fields?: string;
|
|
1943
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1944
|
+
key?: string;
|
|
1945
|
+
/** Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`. */
|
|
1946
|
+
name: string;
|
|
1947
|
+
/** OAuth 2.0 token for the current user. */
|
|
1948
|
+
oauth_token?: string;
|
|
1949
|
+
/** Returns response with indentations and line breaks. */
|
|
1950
|
+
prettyPrint?: boolean;
|
|
1951
|
+
/** 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. */
|
|
1952
|
+
quotaUser?: string;
|
|
1953
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1954
|
+
upload_protocol?: string;
|
|
1955
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1956
|
+
uploadType?: string;
|
|
1957
|
+
}): Request<{}>;
|
|
1958
|
+
/** Gets metadata on a pending or completed Backup. */
|
|
1959
|
+
get(request?: {
|
|
1960
|
+
/** V1 error format. */
|
|
1961
|
+
"$.xgafv"?: string;
|
|
1962
|
+
/** OAuth access token. */
|
|
1963
|
+
access_token?: string;
|
|
1964
|
+
/** Data format for response. */
|
|
1965
|
+
alt?: string;
|
|
1966
|
+
/** JSONP */
|
|
1967
|
+
callback?: string;
|
|
1968
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1969
|
+
fields?: string;
|
|
1970
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1971
|
+
key?: string;
|
|
1972
|
+
/** Required. Name of the backup. Values are of the form `projects//instances//backups/`. */
|
|
1973
|
+
name: string;
|
|
1974
|
+
/** OAuth 2.0 token for the current user. */
|
|
1975
|
+
oauth_token?: string;
|
|
1976
|
+
/** Returns response with indentations and line breaks. */
|
|
1977
|
+
prettyPrint?: boolean;
|
|
1978
|
+
/** 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. */
|
|
1979
|
+
quotaUser?: string;
|
|
1980
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1981
|
+
upload_protocol?: string;
|
|
1982
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1983
|
+
uploadType?: string;
|
|
1984
|
+
}): Request<Backup>;
|
|
1985
|
+
/**
|
|
1986
|
+
* Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires
|
|
1987
|
+
* `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
|
|
1988
|
+
*/
|
|
1989
|
+
getIamPolicy(request: {
|
|
1990
|
+
/** V1 error format. */
|
|
1991
|
+
"$.xgafv"?: string;
|
|
1992
|
+
/** OAuth access token. */
|
|
1993
|
+
access_token?: string;
|
|
1994
|
+
/** Data format for response. */
|
|
1995
|
+
alt?: string;
|
|
1996
|
+
/** JSONP */
|
|
1997
|
+
callback?: string;
|
|
1998
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1999
|
+
fields?: string;
|
|
2000
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2001
|
+
key?: string;
|
|
2002
|
+
/** OAuth 2.0 token for the current user. */
|
|
2003
|
+
oauth_token?: string;
|
|
2004
|
+
/** Returns response with indentations and line breaks. */
|
|
2005
|
+
prettyPrint?: boolean;
|
|
2006
|
+
/** 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. */
|
|
2007
|
+
quotaUser?: string;
|
|
2008
|
+
/**
|
|
2009
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
2010
|
+
* for database resources.
|
|
2011
|
+
*/
|
|
2012
|
+
resource: string;
|
|
2013
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2014
|
+
upload_protocol?: string;
|
|
2015
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2016
|
+
uploadType?: string;
|
|
2017
|
+
},
|
|
2018
|
+
body: GetIamPolicyRequest): Request<Policy>;
|
|
2019
|
+
/** Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. */
|
|
2020
|
+
list(request?: {
|
|
2021
|
+
/** V1 error format. */
|
|
2022
|
+
"$.xgafv"?: string;
|
|
2023
|
+
/** OAuth access token. */
|
|
2024
|
+
access_token?: string;
|
|
2025
|
+
/** Data format for response. */
|
|
2026
|
+
alt?: string;
|
|
2027
|
+
/** JSONP */
|
|
2028
|
+
callback?: string;
|
|
2029
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2030
|
+
fields?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a
|
|
2033
|
+
* string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case
|
|
2034
|
+
* sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) *
|
|
2035
|
+
* `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple
|
|
2036
|
+
* expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a
|
|
2037
|
+
* few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup
|
|
2038
|
+
* is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the
|
|
2039
|
+
* string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before
|
|
2040
|
+
* 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB
|
|
2041
|
+
*/
|
|
2042
|
+
filter?: string;
|
|
2043
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2044
|
+
key?: string;
|
|
2045
|
+
/** OAuth 2.0 token for the current user. */
|
|
2046
|
+
oauth_token?: string;
|
|
2047
|
+
/** Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
2048
|
+
pageSize?: number;
|
|
2049
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`. */
|
|
2050
|
+
pageToken?: string;
|
|
2051
|
+
/** Required. The instance to list backups from. Values are of the form `projects//instances/`. */
|
|
2052
|
+
parent: string;
|
|
2053
|
+
/** Returns response with indentations and line breaks. */
|
|
2054
|
+
prettyPrint?: boolean;
|
|
2055
|
+
/** 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. */
|
|
2056
|
+
quotaUser?: string;
|
|
2057
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2058
|
+
upload_protocol?: string;
|
|
2059
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2060
|
+
uploadType?: string;
|
|
2061
|
+
}): Request<ListBackupsResponse>;
|
|
2062
|
+
/** Updates a pending or completed Backup. */
|
|
2063
|
+
patch(request: {
|
|
2064
|
+
/** V1 error format. */
|
|
2065
|
+
"$.xgafv"?: string;
|
|
2066
|
+
/** OAuth access token. */
|
|
2067
|
+
access_token?: string;
|
|
2068
|
+
/** Data format for response. */
|
|
2069
|
+
alt?: string;
|
|
2070
|
+
/** JSONP */
|
|
2071
|
+
callback?: string;
|
|
2072
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2073
|
+
fields?: string;
|
|
2074
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2075
|
+
key?: string;
|
|
2076
|
+
/**
|
|
2077
|
+
* 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
|
|
2078
|
+
* `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
|
|
2079
|
+
* instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
|
|
2080
|
+
*/
|
|
2081
|
+
name: string;
|
|
2082
|
+
/** OAuth 2.0 token for the current user. */
|
|
2083
|
+
oauth_token?: string;
|
|
2084
|
+
/** Returns response with indentations and line breaks. */
|
|
2085
|
+
prettyPrint?: boolean;
|
|
2086
|
+
/** 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. */
|
|
2087
|
+
quotaUser?: string;
|
|
2088
|
+
/**
|
|
2089
|
+
* 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.
|
|
2090
|
+
* The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
|
|
2091
|
+
*/
|
|
2092
|
+
updateMask?: string;
|
|
2093
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2094
|
+
upload_protocol?: string;
|
|
2095
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2096
|
+
uploadType?: string;
|
|
2097
|
+
/** Request body */
|
|
2098
|
+
resource: Backup;
|
|
2099
|
+
}): Request<Backup>;
|
|
2100
|
+
patch(request: {
|
|
2101
|
+
/** V1 error format. */
|
|
2102
|
+
"$.xgafv"?: string;
|
|
2103
|
+
/** OAuth access token. */
|
|
2104
|
+
access_token?: string;
|
|
2105
|
+
/** Data format for response. */
|
|
2106
|
+
alt?: string;
|
|
2107
|
+
/** JSONP */
|
|
2108
|
+
callback?: string;
|
|
2109
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2110
|
+
fields?: string;
|
|
2111
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2112
|
+
key?: string;
|
|
2113
|
+
/**
|
|
2114
|
+
* 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
|
|
2115
|
+
* `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
|
|
2116
|
+
* instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
|
|
2117
|
+
*/
|
|
2118
|
+
name: string;
|
|
2119
|
+
/** OAuth 2.0 token for the current user. */
|
|
2120
|
+
oauth_token?: string;
|
|
2121
|
+
/** Returns response with indentations and line breaks. */
|
|
2122
|
+
prettyPrint?: boolean;
|
|
2123
|
+
/** 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. */
|
|
2124
|
+
quotaUser?: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* 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.
|
|
2127
|
+
* The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
|
|
2128
|
+
*/
|
|
2129
|
+
updateMask?: string;
|
|
2130
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2131
|
+
upload_protocol?: string;
|
|
2132
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2133
|
+
uploadType?: string;
|
|
2134
|
+
},
|
|
2135
|
+
body: Backup): Request<Backup>;
|
|
2136
|
+
/**
|
|
2137
|
+
* Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For
|
|
2138
|
+
* backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
|
|
2139
|
+
*/
|
|
2140
|
+
setIamPolicy(request: {
|
|
2141
|
+
/** V1 error format. */
|
|
2142
|
+
"$.xgafv"?: string;
|
|
2143
|
+
/** OAuth access token. */
|
|
2144
|
+
access_token?: string;
|
|
2145
|
+
/** Data format for response. */
|
|
2146
|
+
alt?: string;
|
|
2147
|
+
/** JSONP */
|
|
2148
|
+
callback?: string;
|
|
2149
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2150
|
+
fields?: string;
|
|
2151
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2152
|
+
key?: string;
|
|
2153
|
+
/** OAuth 2.0 token for the current user. */
|
|
2154
|
+
oauth_token?: string;
|
|
2155
|
+
/** Returns response with indentations and line breaks. */
|
|
2156
|
+
prettyPrint?: boolean;
|
|
2157
|
+
/** 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. */
|
|
2158
|
+
quotaUser?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for
|
|
2161
|
+
* databases resources.
|
|
2162
|
+
*/
|
|
2163
|
+
resource: string;
|
|
2164
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2165
|
+
upload_protocol?: string;
|
|
2166
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2167
|
+
uploadType?: string;
|
|
2168
|
+
},
|
|
2169
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
2170
|
+
/**
|
|
2171
|
+
* 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
|
|
2172
|
+
* 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
|
|
2173
|
+
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
|
|
2174
|
+
*/
|
|
2175
|
+
testIamPermissions(request: {
|
|
2176
|
+
/** V1 error format. */
|
|
2177
|
+
"$.xgafv"?: string;
|
|
2178
|
+
/** OAuth access token. */
|
|
2179
|
+
access_token?: string;
|
|
2180
|
+
/** Data format for response. */
|
|
2181
|
+
alt?: string;
|
|
2182
|
+
/** JSONP */
|
|
2183
|
+
callback?: string;
|
|
2184
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2185
|
+
fields?: string;
|
|
2186
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2187
|
+
key?: string;
|
|
2188
|
+
/** OAuth 2.0 token for the current user. */
|
|
2189
|
+
oauth_token?: string;
|
|
2190
|
+
/** Returns response with indentations and line breaks. */
|
|
2191
|
+
prettyPrint?: boolean;
|
|
2192
|
+
/** 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. */
|
|
2193
|
+
quotaUser?: string;
|
|
2194
|
+
/**
|
|
2195
|
+
* REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
2196
|
+
* for database resources.
|
|
2197
|
+
*/
|
|
2198
|
+
resource: string;
|
|
2199
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2200
|
+
upload_protocol?: string;
|
|
2201
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2202
|
+
uploadType?: string;
|
|
2203
|
+
},
|
|
2204
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
2205
|
+
operations: OperationsResource;
|
|
2206
|
+
}
|
|
2207
|
+
interface DatabaseOperationsResource {
|
|
2208
|
+
/**
|
|
2209
|
+
* Lists database longrunning-operations. A database operation has a name of the form `projects//instances//databases//operations/`. The long-running operation metadata field type
|
|
2210
|
+
* `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.
|
|
2211
|
+
*/
|
|
2212
|
+
list(request?: {
|
|
2213
|
+
/** V1 error format. */
|
|
2214
|
+
"$.xgafv"?: string;
|
|
2215
|
+
/** OAuth access token. */
|
|
2216
|
+
access_token?: string;
|
|
2217
|
+
/** Data format for response. */
|
|
2218
|
+
alt?: string;
|
|
2219
|
+
/** JSONP */
|
|
2220
|
+
callback?: string;
|
|
2221
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2222
|
+
fields?: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a
|
|
2225
|
+
* string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case
|
|
2226
|
+
* sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress,
|
|
2227
|
+
* else true. * `metadata.@type` - the type of metadata. For example, the type string for RestoreDatabaseMetadata is
|
|
2228
|
+
* `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if
|
|
2229
|
+
* filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in
|
|
2230
|
+
* response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify
|
|
2231
|
+
* AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. *
|
|
2232
|
+
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \ `(metadata.source_type:BACKUP) AND` \
|
|
2233
|
+
* `(metadata.backup_info.backup:backup_howl) AND` \ `(metadata.name:restored_howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Return
|
|
2234
|
+
* operations where: * The operation's metadata type is RestoreDatabaseMetadata. * The database is restored from a backup. * The backup name contains "backup_howl". * The restored
|
|
2235
|
+
* database's name contains "restored_howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error.
|
|
2236
|
+
*/
|
|
2237
|
+
filter?: string;
|
|
2238
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2239
|
+
key?: string;
|
|
2240
|
+
/** OAuth 2.0 token for the current user. */
|
|
2241
|
+
oauth_token?: string;
|
|
2242
|
+
/** Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
2243
|
+
pageSize?: number;
|
|
2244
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same `parent` and with the same `filter`. */
|
|
2245
|
+
pageToken?: string;
|
|
2246
|
+
/** Required. The instance of the database operations. Values are of the form `projects//instances/`. */
|
|
2247
|
+
parent: string;
|
|
2248
|
+
/** Returns response with indentations and line breaks. */
|
|
2249
|
+
prettyPrint?: boolean;
|
|
2250
|
+
/** 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. */
|
|
2251
|
+
quotaUser?: string;
|
|
2252
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2253
|
+
upload_protocol?: string;
|
|
2254
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2255
|
+
uploadType?: string;
|
|
2256
|
+
}): Request<ListDatabaseOperationsResponse>;
|
|
2257
|
+
}
|
|
2258
|
+
interface DatabaseRolesResource {
|
|
2259
|
+
/** Lists Cloud Spanner database roles. */
|
|
2260
|
+
list(request?: {
|
|
2261
|
+
/** V1 error format. */
|
|
2262
|
+
"$.xgafv"?: string;
|
|
2263
|
+
/** OAuth access token. */
|
|
2264
|
+
access_token?: string;
|
|
2265
|
+
/** Data format for response. */
|
|
2266
|
+
alt?: string;
|
|
2267
|
+
/** JSONP */
|
|
2268
|
+
callback?: string;
|
|
2269
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2270
|
+
fields?: string;
|
|
2271
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2272
|
+
key?: string;
|
|
2273
|
+
/** OAuth 2.0 token for the current user. */
|
|
2274
|
+
oauth_token?: string;
|
|
2275
|
+
/** Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
2276
|
+
pageSize?: number;
|
|
2277
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseRolesResponse. */
|
|
2278
|
+
pageToken?: string;
|
|
2279
|
+
/** Required. The database whose roles should be listed. Values are of the form `projects//instances//databases/`. */
|
|
2280
|
+
parent: string;
|
|
2281
|
+
/** Returns response with indentations and line breaks. */
|
|
2282
|
+
prettyPrint?: boolean;
|
|
2283
|
+
/** 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. */
|
|
2284
|
+
quotaUser?: string;
|
|
2285
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2286
|
+
upload_protocol?: string;
|
|
2287
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2288
|
+
uploadType?: string;
|
|
2289
|
+
}): Request<ListDatabaseRolesResponse>;
|
|
2290
|
+
/**
|
|
2291
|
+
* 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
|
|
2292
|
+
* 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
|
|
2293
|
+
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
|
|
2294
|
+
*/
|
|
2295
|
+
testIamPermissions(request: {
|
|
2296
|
+
/** V1 error format. */
|
|
2297
|
+
"$.xgafv"?: string;
|
|
2298
|
+
/** OAuth access token. */
|
|
2299
|
+
access_token?: string;
|
|
2300
|
+
/** Data format for response. */
|
|
2301
|
+
alt?: string;
|
|
2302
|
+
/** JSONP */
|
|
2303
|
+
callback?: string;
|
|
2304
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2305
|
+
fields?: string;
|
|
2306
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2307
|
+
key?: string;
|
|
2308
|
+
/** OAuth 2.0 token for the current user. */
|
|
2309
|
+
oauth_token?: string;
|
|
2310
|
+
/** Returns response with indentations and line breaks. */
|
|
2311
|
+
prettyPrint?: boolean;
|
|
2312
|
+
/** 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. */
|
|
2313
|
+
quotaUser?: string;
|
|
2314
|
+
/**
|
|
2315
|
+
* REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
2316
|
+
* for database resources.
|
|
2317
|
+
*/
|
|
2318
|
+
resource: string;
|
|
2319
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2320
|
+
upload_protocol?: string;
|
|
2321
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2322
|
+
uploadType?: string;
|
|
2323
|
+
},
|
|
2324
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
2325
|
+
}
|
|
2326
|
+
interface OperationsResource {
|
|
2327
|
+
/**
|
|
2328
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
2329
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
2330
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
2331
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
2332
|
+
*/
|
|
2333
|
+
cancel(request?: {
|
|
2334
|
+
/** V1 error format. */
|
|
2335
|
+
"$.xgafv"?: string;
|
|
2336
|
+
/** OAuth access token. */
|
|
2337
|
+
access_token?: string;
|
|
2338
|
+
/** Data format for response. */
|
|
2339
|
+
alt?: string;
|
|
2340
|
+
/** JSONP */
|
|
2341
|
+
callback?: string;
|
|
2342
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2343
|
+
fields?: string;
|
|
2344
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2345
|
+
key?: string;
|
|
2346
|
+
/** The name of the operation resource to be cancelled. */
|
|
2347
|
+
name: string;
|
|
2348
|
+
/** OAuth 2.0 token for the current user. */
|
|
2349
|
+
oauth_token?: string;
|
|
2350
|
+
/** Returns response with indentations and line breaks. */
|
|
2351
|
+
prettyPrint?: boolean;
|
|
2352
|
+
/** 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. */
|
|
2353
|
+
quotaUser?: string;
|
|
2354
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2355
|
+
upload_protocol?: string;
|
|
2356
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2357
|
+
uploadType?: string;
|
|
2358
|
+
}): Request<{}>;
|
|
2359
|
+
/**
|
|
2360
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
|
|
2361
|
+
* support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
2362
|
+
*/
|
|
2363
|
+
delete(request?: {
|
|
2364
|
+
/** V1 error format. */
|
|
2365
|
+
"$.xgafv"?: string;
|
|
2366
|
+
/** OAuth access token. */
|
|
2367
|
+
access_token?: string;
|
|
2368
|
+
/** Data format for response. */
|
|
2369
|
+
alt?: string;
|
|
2370
|
+
/** JSONP */
|
|
2371
|
+
callback?: string;
|
|
2372
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2373
|
+
fields?: string;
|
|
2374
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2375
|
+
key?: string;
|
|
2376
|
+
/** The name of the operation resource to be deleted. */
|
|
2377
|
+
name: string;
|
|
2378
|
+
/** OAuth 2.0 token for the current user. */
|
|
2379
|
+
oauth_token?: string;
|
|
2380
|
+
/** Returns response with indentations and line breaks. */
|
|
2381
|
+
prettyPrint?: boolean;
|
|
2382
|
+
/** 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. */
|
|
2383
|
+
quotaUser?: string;
|
|
2384
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2385
|
+
upload_protocol?: string;
|
|
2386
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2387
|
+
uploadType?: string;
|
|
2388
|
+
}): Request<{}>;
|
|
2389
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
2390
|
+
get(request?: {
|
|
2391
|
+
/** V1 error format. */
|
|
2392
|
+
"$.xgafv"?: string;
|
|
2393
|
+
/** OAuth access token. */
|
|
2394
|
+
access_token?: string;
|
|
2395
|
+
/** Data format for response. */
|
|
2396
|
+
alt?: string;
|
|
2397
|
+
/** JSONP */
|
|
2398
|
+
callback?: string;
|
|
2399
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2400
|
+
fields?: string;
|
|
2401
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2402
|
+
key?: string;
|
|
2403
|
+
/** The name of the operation resource. */
|
|
2404
|
+
name: string;
|
|
2405
|
+
/** OAuth 2.0 token for the current user. */
|
|
2406
|
+
oauth_token?: string;
|
|
2407
|
+
/** Returns response with indentations and line breaks. */
|
|
2408
|
+
prettyPrint?: boolean;
|
|
2409
|
+
/** 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. */
|
|
2410
|
+
quotaUser?: string;
|
|
2411
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2412
|
+
upload_protocol?: string;
|
|
2413
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2414
|
+
uploadType?: string;
|
|
2415
|
+
}): Request<Operation>;
|
|
2416
|
+
/**
|
|
2417
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
2418
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
2419
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
2420
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
2421
|
+
*/
|
|
2422
|
+
list(request?: {
|
|
2423
|
+
/** V1 error format. */
|
|
2424
|
+
"$.xgafv"?: string;
|
|
2425
|
+
/** OAuth access token. */
|
|
2426
|
+
access_token?: string;
|
|
2427
|
+
/** Data format for response. */
|
|
2428
|
+
alt?: string;
|
|
2429
|
+
/** JSONP */
|
|
2430
|
+
callback?: string;
|
|
2431
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2432
|
+
fields?: string;
|
|
2433
|
+
/** The standard list filter. */
|
|
2434
|
+
filter?: string;
|
|
2435
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2436
|
+
key?: string;
|
|
2437
|
+
/** The name of the operation's parent resource. */
|
|
2438
|
+
name: string;
|
|
2439
|
+
/** OAuth 2.0 token for the current user. */
|
|
2440
|
+
oauth_token?: string;
|
|
2441
|
+
/** The standard list page size. */
|
|
2442
|
+
pageSize?: number;
|
|
2443
|
+
/** The standard list page token. */
|
|
2444
|
+
pageToken?: string;
|
|
2445
|
+
/** Returns response with indentations and line breaks. */
|
|
2446
|
+
prettyPrint?: boolean;
|
|
2447
|
+
/** 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. */
|
|
2448
|
+
quotaUser?: string;
|
|
2449
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2450
|
+
upload_protocol?: string;
|
|
2451
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2452
|
+
uploadType?: string;
|
|
2453
|
+
}): Request<ListOperationsResponse>;
|
|
2454
|
+
}
|
|
2455
|
+
interface SessionsResource {
|
|
2456
|
+
/** Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. */
|
|
2457
|
+
batchCreate(request: {
|
|
2458
|
+
/** V1 error format. */
|
|
2459
|
+
"$.xgafv"?: string;
|
|
2460
|
+
/** OAuth access token. */
|
|
2461
|
+
access_token?: string;
|
|
2462
|
+
/** Data format for response. */
|
|
2463
|
+
alt?: string;
|
|
2464
|
+
/** JSONP */
|
|
2465
|
+
callback?: string;
|
|
2466
|
+
/** Required. The database in which the new sessions are created. */
|
|
2467
|
+
database: string;
|
|
2468
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2469
|
+
fields?: string;
|
|
2470
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2471
|
+
key?: string;
|
|
2472
|
+
/** OAuth 2.0 token for the current user. */
|
|
2473
|
+
oauth_token?: string;
|
|
2474
|
+
/** Returns response with indentations and line breaks. */
|
|
2475
|
+
prettyPrint?: boolean;
|
|
2476
|
+
/** 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. */
|
|
2477
|
+
quotaUser?: string;
|
|
2478
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2479
|
+
upload_protocol?: string;
|
|
2480
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2481
|
+
uploadType?: string;
|
|
2482
|
+
/** Request body */
|
|
2483
|
+
resource: BatchCreateSessionsRequest;
|
|
2484
|
+
}): Request<BatchCreateSessionsResponse>;
|
|
2485
|
+
batchCreate(request: {
|
|
2486
|
+
/** V1 error format. */
|
|
2487
|
+
"$.xgafv"?: string;
|
|
2488
|
+
/** OAuth access token. */
|
|
2489
|
+
access_token?: string;
|
|
2490
|
+
/** Data format for response. */
|
|
2491
|
+
alt?: string;
|
|
2492
|
+
/** JSONP */
|
|
2493
|
+
callback?: string;
|
|
2494
|
+
/** Required. The database in which the new sessions are created. */
|
|
2495
|
+
database: string;
|
|
2496
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2497
|
+
fields?: string;
|
|
2498
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2499
|
+
key?: string;
|
|
2500
|
+
/** OAuth 2.0 token for the current user. */
|
|
2501
|
+
oauth_token?: string;
|
|
2502
|
+
/** Returns response with indentations and line breaks. */
|
|
2503
|
+
prettyPrint?: boolean;
|
|
2504
|
+
/** 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. */
|
|
2505
|
+
quotaUser?: string;
|
|
2506
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2507
|
+
upload_protocol?: string;
|
|
2508
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2509
|
+
uploadType?: string;
|
|
2510
|
+
},
|
|
2511
|
+
body: BatchCreateSessionsRequest): Request<BatchCreateSessionsResponse>;
|
|
2512
|
+
/** Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. */
|
|
2513
|
+
beginTransaction(request: {
|
|
2514
|
+
/** V1 error format. */
|
|
2515
|
+
"$.xgafv"?: string;
|
|
2516
|
+
/** OAuth access token. */
|
|
2517
|
+
access_token?: string;
|
|
2518
|
+
/** Data format for response. */
|
|
2519
|
+
alt?: string;
|
|
2520
|
+
/** JSONP */
|
|
2521
|
+
callback?: string;
|
|
2522
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2523
|
+
fields?: string;
|
|
2524
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2525
|
+
key?: string;
|
|
2526
|
+
/** OAuth 2.0 token for the current user. */
|
|
2527
|
+
oauth_token?: string;
|
|
2528
|
+
/** Returns response with indentations and line breaks. */
|
|
2529
|
+
prettyPrint?: boolean;
|
|
2530
|
+
/** 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. */
|
|
2531
|
+
quotaUser?: string;
|
|
2532
|
+
/** Required. The session in which the transaction runs. */
|
|
2533
|
+
session: string;
|
|
2534
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2535
|
+
upload_protocol?: string;
|
|
2536
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2537
|
+
uploadType?: string;
|
|
2538
|
+
/** Request body */
|
|
2539
|
+
resource: BeginTransactionRequest;
|
|
2540
|
+
}): Request<Transaction>;
|
|
2541
|
+
beginTransaction(request: {
|
|
2542
|
+
/** V1 error format. */
|
|
2543
|
+
"$.xgafv"?: string;
|
|
2544
|
+
/** OAuth access token. */
|
|
2545
|
+
access_token?: string;
|
|
2546
|
+
/** Data format for response. */
|
|
2547
|
+
alt?: string;
|
|
2548
|
+
/** JSONP */
|
|
2549
|
+
callback?: string;
|
|
2550
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2551
|
+
fields?: string;
|
|
2552
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2553
|
+
key?: string;
|
|
2554
|
+
/** OAuth 2.0 token for the current user. */
|
|
2555
|
+
oauth_token?: string;
|
|
2556
|
+
/** Returns response with indentations and line breaks. */
|
|
2557
|
+
prettyPrint?: boolean;
|
|
2558
|
+
/** 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. */
|
|
2559
|
+
quotaUser?: string;
|
|
2560
|
+
/** Required. The session in which the transaction runs. */
|
|
2561
|
+
session: string;
|
|
2562
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2563
|
+
upload_protocol?: string;
|
|
2564
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2565
|
+
uploadType?: string;
|
|
2566
|
+
},
|
|
2567
|
+
body: BeginTransactionRequest): Request<Transaction>;
|
|
2568
|
+
/**
|
|
2569
|
+
* 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
|
|
2570
|
+
* 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
|
|
2571
|
+
* 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+
|
|
2572
|
+
* 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
|
|
2573
|
+
* things as they are now.
|
|
2574
|
+
*/
|
|
2575
|
+
commit(request: {
|
|
2576
|
+
/** V1 error format. */
|
|
2577
|
+
"$.xgafv"?: string;
|
|
2578
|
+
/** OAuth access token. */
|
|
2579
|
+
access_token?: string;
|
|
2580
|
+
/** Data format for response. */
|
|
2581
|
+
alt?: string;
|
|
2582
|
+
/** JSONP */
|
|
2583
|
+
callback?: string;
|
|
2584
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2585
|
+
fields?: string;
|
|
2586
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2587
|
+
key?: string;
|
|
2588
|
+
/** OAuth 2.0 token for the current user. */
|
|
2589
|
+
oauth_token?: string;
|
|
2590
|
+
/** Returns response with indentations and line breaks. */
|
|
2591
|
+
prettyPrint?: boolean;
|
|
2592
|
+
/** 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. */
|
|
2593
|
+
quotaUser?: string;
|
|
2594
|
+
/** Required. The session in which the transaction to be committed is running. */
|
|
2595
|
+
session: string;
|
|
2596
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2597
|
+
upload_protocol?: string;
|
|
2598
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2599
|
+
uploadType?: string;
|
|
2600
|
+
/** Request body */
|
|
2601
|
+
resource: CommitRequest;
|
|
2602
|
+
}): Request<CommitResponse>;
|
|
2603
|
+
commit(request: {
|
|
2604
|
+
/** V1 error format. */
|
|
2605
|
+
"$.xgafv"?: string;
|
|
2606
|
+
/** OAuth access token. */
|
|
2607
|
+
access_token?: string;
|
|
2608
|
+
/** Data format for response. */
|
|
2609
|
+
alt?: string;
|
|
2610
|
+
/** JSONP */
|
|
2611
|
+
callback?: string;
|
|
2612
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2613
|
+
fields?: string;
|
|
2614
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2615
|
+
key?: string;
|
|
2616
|
+
/** OAuth 2.0 token for the current user. */
|
|
2617
|
+
oauth_token?: string;
|
|
2618
|
+
/** Returns response with indentations and line breaks. */
|
|
2619
|
+
prettyPrint?: boolean;
|
|
2620
|
+
/** 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. */
|
|
2621
|
+
quotaUser?: string;
|
|
2622
|
+
/** Required. The session in which the transaction to be committed is running. */
|
|
2623
|
+
session: string;
|
|
2624
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2625
|
+
upload_protocol?: string;
|
|
2626
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2627
|
+
uploadType?: string;
|
|
2628
|
+
},
|
|
2629
|
+
body: CommitRequest): Request<CommitResponse>;
|
|
2630
|
+
/**
|
|
2631
|
+
* 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
|
|
2632
|
+
* 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
|
|
2633
|
+
* 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
|
|
2634
|
+
* 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
|
|
2635
|
+
* return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`.
|
|
2636
|
+
*/
|
|
2637
|
+
create(request: {
|
|
2638
|
+
/** V1 error format. */
|
|
2639
|
+
"$.xgafv"?: string;
|
|
2640
|
+
/** OAuth access token. */
|
|
2641
|
+
access_token?: string;
|
|
2642
|
+
/** Data format for response. */
|
|
2643
|
+
alt?: string;
|
|
2644
|
+
/** JSONP */
|
|
2645
|
+
callback?: string;
|
|
2646
|
+
/** Required. The database in which the new session is created. */
|
|
2647
|
+
database: string;
|
|
2648
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2649
|
+
fields?: string;
|
|
2650
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2651
|
+
key?: string;
|
|
2652
|
+
/** OAuth 2.0 token for the current user. */
|
|
2653
|
+
oauth_token?: string;
|
|
2654
|
+
/** Returns response with indentations and line breaks. */
|
|
2655
|
+
prettyPrint?: boolean;
|
|
2656
|
+
/** 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. */
|
|
2657
|
+
quotaUser?: string;
|
|
2658
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2659
|
+
upload_protocol?: string;
|
|
2660
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2661
|
+
uploadType?: string;
|
|
2662
|
+
/** Request body */
|
|
2663
|
+
resource: CreateSessionRequest;
|
|
2664
|
+
}): Request<Session>;
|
|
2665
|
+
create(request: {
|
|
2666
|
+
/** V1 error format. */
|
|
2667
|
+
"$.xgafv"?: string;
|
|
2668
|
+
/** OAuth access token. */
|
|
2669
|
+
access_token?: string;
|
|
2670
|
+
/** Data format for response. */
|
|
2671
|
+
alt?: string;
|
|
2672
|
+
/** JSONP */
|
|
2673
|
+
callback?: string;
|
|
2674
|
+
/** Required. The database in which the new session is created. */
|
|
2675
|
+
database: string;
|
|
2676
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2677
|
+
fields?: string;
|
|
2678
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2679
|
+
key?: string;
|
|
2680
|
+
/** OAuth 2.0 token for the current user. */
|
|
2681
|
+
oauth_token?: string;
|
|
2682
|
+
/** Returns response with indentations and line breaks. */
|
|
2683
|
+
prettyPrint?: boolean;
|
|
2684
|
+
/** 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. */
|
|
2685
|
+
quotaUser?: string;
|
|
2686
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2687
|
+
upload_protocol?: string;
|
|
2688
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2689
|
+
uploadType?: string;
|
|
2690
|
+
},
|
|
2691
|
+
body: CreateSessionRequest): Request<Session>;
|
|
2692
|
+
/** Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. */
|
|
2693
|
+
delete(request?: {
|
|
2694
|
+
/** V1 error format. */
|
|
2695
|
+
"$.xgafv"?: string;
|
|
2696
|
+
/** OAuth access token. */
|
|
2697
|
+
access_token?: string;
|
|
2698
|
+
/** Data format for response. */
|
|
2699
|
+
alt?: string;
|
|
2700
|
+
/** JSONP */
|
|
2701
|
+
callback?: string;
|
|
2702
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2703
|
+
fields?: string;
|
|
2704
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2705
|
+
key?: string;
|
|
2706
|
+
/** Required. The name of the session to delete. */
|
|
2707
|
+
name: string;
|
|
2708
|
+
/** OAuth 2.0 token for the current user. */
|
|
2709
|
+
oauth_token?: string;
|
|
2710
|
+
/** Returns response with indentations and line breaks. */
|
|
2711
|
+
prettyPrint?: boolean;
|
|
2712
|
+
/** 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. */
|
|
2713
|
+
quotaUser?: string;
|
|
2714
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2715
|
+
upload_protocol?: string;
|
|
2716
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2717
|
+
uploadType?: string;
|
|
2718
|
+
}): Request<{}>;
|
|
2719
|
+
/**
|
|
2720
|
+
* Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in
|
|
2721
|
+
* sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed.
|
|
2722
|
+
* Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed.
|
|
2723
|
+
*/
|
|
2724
|
+
executeBatchDml(request: {
|
|
2725
|
+
/** V1 error format. */
|
|
2726
|
+
"$.xgafv"?: string;
|
|
2727
|
+
/** OAuth access token. */
|
|
2728
|
+
access_token?: string;
|
|
2729
|
+
/** Data format for response. */
|
|
2730
|
+
alt?: string;
|
|
2731
|
+
/** JSONP */
|
|
2732
|
+
callback?: string;
|
|
2733
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2734
|
+
fields?: string;
|
|
2735
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2736
|
+
key?: string;
|
|
2737
|
+
/** OAuth 2.0 token for the current user. */
|
|
2738
|
+
oauth_token?: string;
|
|
2739
|
+
/** Returns response with indentations and line breaks. */
|
|
2740
|
+
prettyPrint?: boolean;
|
|
2741
|
+
/** 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. */
|
|
2742
|
+
quotaUser?: string;
|
|
2743
|
+
/** Required. The session in which the DML statements should be performed. */
|
|
2744
|
+
session: string;
|
|
2745
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2746
|
+
upload_protocol?: string;
|
|
2747
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2748
|
+
uploadType?: string;
|
|
2749
|
+
/** Request body */
|
|
2750
|
+
resource: ExecuteBatchDmlRequest;
|
|
2751
|
+
}): Request<ExecuteBatchDmlResponse>;
|
|
2752
|
+
executeBatchDml(request: {
|
|
2753
|
+
/** V1 error format. */
|
|
2754
|
+
"$.xgafv"?: string;
|
|
2755
|
+
/** OAuth access token. */
|
|
2756
|
+
access_token?: string;
|
|
2757
|
+
/** Data format for response. */
|
|
2758
|
+
alt?: string;
|
|
2759
|
+
/** JSONP */
|
|
2760
|
+
callback?: string;
|
|
2761
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2762
|
+
fields?: string;
|
|
2763
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2764
|
+
key?: string;
|
|
2765
|
+
/** OAuth 2.0 token for the current user. */
|
|
2766
|
+
oauth_token?: string;
|
|
2767
|
+
/** Returns response with indentations and line breaks. */
|
|
2768
|
+
prettyPrint?: boolean;
|
|
2769
|
+
/** 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. */
|
|
2770
|
+
quotaUser?: string;
|
|
2771
|
+
/** Required. The session in which the DML statements should be performed. */
|
|
2772
|
+
session: string;
|
|
2773
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2774
|
+
upload_protocol?: string;
|
|
2775
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2776
|
+
uploadType?: string;
|
|
2777
|
+
},
|
|
2778
|
+
body: ExecuteBatchDmlRequest): Request<ExecuteBatchDmlResponse>;
|
|
2779
|
+
/**
|
|
2780
|
+
* 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,
|
|
2781
|
+
* 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
|
|
2782
|
+
* from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
|
|
2783
|
+
*/
|
|
2784
|
+
executeSql(request: {
|
|
2785
|
+
/** V1 error format. */
|
|
2786
|
+
"$.xgafv"?: string;
|
|
2787
|
+
/** OAuth access token. */
|
|
2788
|
+
access_token?: string;
|
|
2789
|
+
/** Data format for response. */
|
|
2790
|
+
alt?: string;
|
|
2791
|
+
/** JSONP */
|
|
2792
|
+
callback?: string;
|
|
2793
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2794
|
+
fields?: string;
|
|
2795
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2796
|
+
key?: string;
|
|
2797
|
+
/** OAuth 2.0 token for the current user. */
|
|
2798
|
+
oauth_token?: string;
|
|
2799
|
+
/** Returns response with indentations and line breaks. */
|
|
2800
|
+
prettyPrint?: boolean;
|
|
2801
|
+
/** 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. */
|
|
2802
|
+
quotaUser?: string;
|
|
2803
|
+
/** Required. The session in which the SQL query should be performed. */
|
|
2804
|
+
session: string;
|
|
2805
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2806
|
+
upload_protocol?: string;
|
|
2807
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2808
|
+
uploadType?: string;
|
|
2809
|
+
/** Request body */
|
|
2810
|
+
resource: ExecuteSqlRequest;
|
|
2811
|
+
}): Request<ResultSet>;
|
|
2812
|
+
executeSql(request: {
|
|
2813
|
+
/** V1 error format. */
|
|
2814
|
+
"$.xgafv"?: string;
|
|
2815
|
+
/** OAuth access token. */
|
|
2816
|
+
access_token?: string;
|
|
2817
|
+
/** Data format for response. */
|
|
2818
|
+
alt?: string;
|
|
2819
|
+
/** JSONP */
|
|
2820
|
+
callback?: string;
|
|
2821
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2822
|
+
fields?: string;
|
|
2823
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2824
|
+
key?: string;
|
|
2825
|
+
/** OAuth 2.0 token for the current user. */
|
|
2826
|
+
oauth_token?: string;
|
|
2827
|
+
/** Returns response with indentations and line breaks. */
|
|
2828
|
+
prettyPrint?: boolean;
|
|
2829
|
+
/** 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. */
|
|
2830
|
+
quotaUser?: string;
|
|
2831
|
+
/** Required. The session in which the SQL query should be performed. */
|
|
2832
|
+
session: string;
|
|
2833
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2834
|
+
upload_protocol?: string;
|
|
2835
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2836
|
+
uploadType?: string;
|
|
2837
|
+
},
|
|
2838
|
+
body: ExecuteSqlRequest): Request<ResultSet>;
|
|
2839
|
+
/**
|
|
2840
|
+
* 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
|
|
2841
|
+
* can exceed 100 MiB, and no column value can exceed 10 MiB.
|
|
2842
|
+
*/
|
|
2843
|
+
executeStreamingSql(request: {
|
|
2844
|
+
/** V1 error format. */
|
|
2845
|
+
"$.xgafv"?: string;
|
|
2846
|
+
/** OAuth access token. */
|
|
2847
|
+
access_token?: string;
|
|
2848
|
+
/** Data format for response. */
|
|
2849
|
+
alt?: string;
|
|
2850
|
+
/** JSONP */
|
|
2851
|
+
callback?: string;
|
|
2852
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2853
|
+
fields?: string;
|
|
2854
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2855
|
+
key?: string;
|
|
2856
|
+
/** OAuth 2.0 token for the current user. */
|
|
2857
|
+
oauth_token?: string;
|
|
2858
|
+
/** Returns response with indentations and line breaks. */
|
|
2859
|
+
prettyPrint?: boolean;
|
|
2860
|
+
/** 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. */
|
|
2861
|
+
quotaUser?: string;
|
|
2862
|
+
/** Required. The session in which the SQL query should be performed. */
|
|
2863
|
+
session: string;
|
|
2864
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2865
|
+
upload_protocol?: string;
|
|
2866
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2867
|
+
uploadType?: string;
|
|
2868
|
+
/** Request body */
|
|
2869
|
+
resource: ExecuteSqlRequest;
|
|
2870
|
+
}): Request<PartialResultSet>;
|
|
2871
|
+
executeStreamingSql(request: {
|
|
2872
|
+
/** V1 error format. */
|
|
2873
|
+
"$.xgafv"?: string;
|
|
2874
|
+
/** OAuth access token. */
|
|
2875
|
+
access_token?: string;
|
|
2876
|
+
/** Data format for response. */
|
|
2877
|
+
alt?: string;
|
|
2878
|
+
/** JSONP */
|
|
2879
|
+
callback?: string;
|
|
2880
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2881
|
+
fields?: string;
|
|
2882
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2883
|
+
key?: string;
|
|
2884
|
+
/** OAuth 2.0 token for the current user. */
|
|
2885
|
+
oauth_token?: string;
|
|
2886
|
+
/** Returns response with indentations and line breaks. */
|
|
2887
|
+
prettyPrint?: boolean;
|
|
2888
|
+
/** 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. */
|
|
2889
|
+
quotaUser?: string;
|
|
2890
|
+
/** Required. The session in which the SQL query should be performed. */
|
|
2891
|
+
session: string;
|
|
2892
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2893
|
+
upload_protocol?: string;
|
|
2894
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2895
|
+
uploadType?: string;
|
|
2896
|
+
},
|
|
2897
|
+
body: ExecuteSqlRequest): Request<PartialResultSet>;
|
|
2898
|
+
/** Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. */
|
|
2899
|
+
get(request?: {
|
|
2900
|
+
/** V1 error format. */
|
|
2901
|
+
"$.xgafv"?: string;
|
|
2902
|
+
/** OAuth access token. */
|
|
2903
|
+
access_token?: string;
|
|
2904
|
+
/** Data format for response. */
|
|
2905
|
+
alt?: string;
|
|
2906
|
+
/** JSONP */
|
|
2907
|
+
callback?: string;
|
|
2908
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2909
|
+
fields?: string;
|
|
2910
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2911
|
+
key?: string;
|
|
2912
|
+
/** Required. The name of the session to retrieve. */
|
|
2913
|
+
name: string;
|
|
2914
|
+
/** OAuth 2.0 token for the current user. */
|
|
2915
|
+
oauth_token?: string;
|
|
2916
|
+
/** Returns response with indentations and line breaks. */
|
|
2917
|
+
prettyPrint?: boolean;
|
|
2918
|
+
/** 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. */
|
|
2919
|
+
quotaUser?: string;
|
|
2920
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2921
|
+
upload_protocol?: string;
|
|
2922
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2923
|
+
uploadType?: string;
|
|
2924
|
+
}): Request<Session>;
|
|
2925
|
+
/** Lists all sessions in a given database. */
|
|
2926
|
+
list(request?: {
|
|
2927
|
+
/** V1 error format. */
|
|
2928
|
+
"$.xgafv"?: string;
|
|
2929
|
+
/** OAuth access token. */
|
|
2930
|
+
access_token?: string;
|
|
2931
|
+
/** Data format for response. */
|
|
2932
|
+
alt?: string;
|
|
2933
|
+
/** JSONP */
|
|
2934
|
+
callback?: string;
|
|
2935
|
+
/** Required. The database in which to list sessions. */
|
|
2936
|
+
database: string;
|
|
2937
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2938
|
+
fields?: string;
|
|
2939
|
+
/**
|
|
2940
|
+
* An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `labels.key` where key is the name of a label
|
|
2941
|
+
* Some examples of using filters are: * `labels.env:*` --> The session has the label "env". * `labels.env:dev` --> The session has the label "env" and the value of the label
|
|
2942
|
+
* contains the string "dev".
|
|
2943
|
+
*/
|
|
2944
|
+
filter?: string;
|
|
2945
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2946
|
+
key?: string;
|
|
2947
|
+
/** OAuth 2.0 token for the current user. */
|
|
2948
|
+
oauth_token?: string;
|
|
2949
|
+
/** Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
2950
|
+
pageSize?: number;
|
|
2951
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse. */
|
|
2952
|
+
pageToken?: string;
|
|
2953
|
+
/** Returns response with indentations and line breaks. */
|
|
2954
|
+
prettyPrint?: boolean;
|
|
2955
|
+
/** 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. */
|
|
2956
|
+
quotaUser?: string;
|
|
2957
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2958
|
+
upload_protocol?: string;
|
|
2959
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2960
|
+
uploadType?: string;
|
|
2961
|
+
}): Request<ListSessionsResponse>;
|
|
2962
|
+
/**
|
|
2963
|
+
* Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a
|
|
2964
|
+
* subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the
|
|
2965
|
+
* ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or
|
|
2966
|
+
* becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.
|
|
2967
|
+
*/
|
|
2968
|
+
partitionQuery(request: {
|
|
2969
|
+
/** V1 error format. */
|
|
2970
|
+
"$.xgafv"?: string;
|
|
2971
|
+
/** OAuth access token. */
|
|
2972
|
+
access_token?: string;
|
|
2973
|
+
/** Data format for response. */
|
|
2974
|
+
alt?: string;
|
|
2975
|
+
/** JSONP */
|
|
2976
|
+
callback?: string;
|
|
2977
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2978
|
+
fields?: string;
|
|
2979
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2980
|
+
key?: string;
|
|
2981
|
+
/** OAuth 2.0 token for the current user. */
|
|
2982
|
+
oauth_token?: string;
|
|
2983
|
+
/** Returns response with indentations and line breaks. */
|
|
2984
|
+
prettyPrint?: boolean;
|
|
2985
|
+
/** 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. */
|
|
2986
|
+
quotaUser?: string;
|
|
2987
|
+
/** Required. The session used to create the partitions. */
|
|
2988
|
+
session: string;
|
|
2989
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2990
|
+
upload_protocol?: string;
|
|
2991
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2992
|
+
uploadType?: string;
|
|
2993
|
+
/** Request body */
|
|
2994
|
+
resource: PartitionQueryRequest;
|
|
2995
|
+
}): Request<PartitionResponse>;
|
|
2996
|
+
partitionQuery(request: {
|
|
2997
|
+
/** V1 error format. */
|
|
2998
|
+
"$.xgafv"?: string;
|
|
2999
|
+
/** OAuth access token. */
|
|
3000
|
+
access_token?: string;
|
|
3001
|
+
/** Data format for response. */
|
|
3002
|
+
alt?: string;
|
|
3003
|
+
/** JSONP */
|
|
3004
|
+
callback?: string;
|
|
3005
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3006
|
+
fields?: string;
|
|
3007
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3008
|
+
key?: string;
|
|
3009
|
+
/** OAuth 2.0 token for the current user. */
|
|
3010
|
+
oauth_token?: string;
|
|
3011
|
+
/** Returns response with indentations and line breaks. */
|
|
3012
|
+
prettyPrint?: boolean;
|
|
3013
|
+
/** 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. */
|
|
3014
|
+
quotaUser?: string;
|
|
3015
|
+
/** Required. The session used to create the partitions. */
|
|
3016
|
+
session: string;
|
|
3017
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3018
|
+
upload_protocol?: string;
|
|
3019
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3020
|
+
uploadType?: string;
|
|
3021
|
+
},
|
|
3022
|
+
body: PartitionQueryRequest): Request<PartitionResponse>;
|
|
3023
|
+
/**
|
|
3024
|
+
* 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
|
|
3025
|
+
* 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
|
|
3026
|
+
* 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
|
|
3027
|
+
* 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
|
|
3028
|
+
* these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.
|
|
3029
|
+
*/
|
|
3030
|
+
partitionRead(request: {
|
|
3031
|
+
/** V1 error format. */
|
|
3032
|
+
"$.xgafv"?: string;
|
|
3033
|
+
/** OAuth access token. */
|
|
3034
|
+
access_token?: string;
|
|
3035
|
+
/** Data format for response. */
|
|
3036
|
+
alt?: string;
|
|
3037
|
+
/** JSONP */
|
|
3038
|
+
callback?: string;
|
|
3039
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3040
|
+
fields?: string;
|
|
3041
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3042
|
+
key?: string;
|
|
3043
|
+
/** OAuth 2.0 token for the current user. */
|
|
3044
|
+
oauth_token?: string;
|
|
3045
|
+
/** Returns response with indentations and line breaks. */
|
|
3046
|
+
prettyPrint?: boolean;
|
|
3047
|
+
/** 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. */
|
|
3048
|
+
quotaUser?: string;
|
|
3049
|
+
/** Required. The session used to create the partitions. */
|
|
3050
|
+
session: string;
|
|
3051
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3052
|
+
upload_protocol?: string;
|
|
3053
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3054
|
+
uploadType?: string;
|
|
3055
|
+
/** Request body */
|
|
3056
|
+
resource: PartitionReadRequest;
|
|
3057
|
+
}): Request<PartitionResponse>;
|
|
3058
|
+
partitionRead(request: {
|
|
3059
|
+
/** V1 error format. */
|
|
3060
|
+
"$.xgafv"?: string;
|
|
3061
|
+
/** OAuth access token. */
|
|
3062
|
+
access_token?: string;
|
|
3063
|
+
/** Data format for response. */
|
|
3064
|
+
alt?: string;
|
|
3065
|
+
/** JSONP */
|
|
3066
|
+
callback?: string;
|
|
3067
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3068
|
+
fields?: string;
|
|
3069
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3070
|
+
key?: string;
|
|
3071
|
+
/** OAuth 2.0 token for the current user. */
|
|
3072
|
+
oauth_token?: string;
|
|
3073
|
+
/** Returns response with indentations and line breaks. */
|
|
3074
|
+
prettyPrint?: boolean;
|
|
3075
|
+
/** 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. */
|
|
3076
|
+
quotaUser?: string;
|
|
3077
|
+
/** Required. The session used to create the partitions. */
|
|
3078
|
+
session: string;
|
|
3079
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3080
|
+
upload_protocol?: string;
|
|
3081
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3082
|
+
uploadType?: string;
|
|
3083
|
+
},
|
|
3084
|
+
body: PartitionReadRequest): Request<PartitionResponse>;
|
|
3085
|
+
/**
|
|
3086
|
+
* 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
|
|
3087
|
+
* 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
|
|
3088
|
+
* 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
|
|
3089
|
+
* instead.
|
|
3090
|
+
*/
|
|
3091
|
+
read(request: {
|
|
3092
|
+
/** V1 error format. */
|
|
3093
|
+
"$.xgafv"?: string;
|
|
3094
|
+
/** OAuth access token. */
|
|
3095
|
+
access_token?: string;
|
|
3096
|
+
/** Data format for response. */
|
|
3097
|
+
alt?: string;
|
|
3098
|
+
/** JSONP */
|
|
3099
|
+
callback?: string;
|
|
3100
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3101
|
+
fields?: string;
|
|
3102
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3103
|
+
key?: string;
|
|
3104
|
+
/** OAuth 2.0 token for the current user. */
|
|
3105
|
+
oauth_token?: string;
|
|
3106
|
+
/** Returns response with indentations and line breaks. */
|
|
3107
|
+
prettyPrint?: boolean;
|
|
3108
|
+
/** 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. */
|
|
3109
|
+
quotaUser?: string;
|
|
3110
|
+
/** Required. The session in which the read should be performed. */
|
|
3111
|
+
session: string;
|
|
3112
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3113
|
+
upload_protocol?: string;
|
|
3114
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3115
|
+
uploadType?: string;
|
|
3116
|
+
/** Request body */
|
|
3117
|
+
resource: ReadRequest;
|
|
3118
|
+
}): Request<ResultSet>;
|
|
3119
|
+
read(request: {
|
|
3120
|
+
/** V1 error format. */
|
|
3121
|
+
"$.xgafv"?: string;
|
|
3122
|
+
/** OAuth access token. */
|
|
3123
|
+
access_token?: string;
|
|
3124
|
+
/** Data format for response. */
|
|
3125
|
+
alt?: string;
|
|
3126
|
+
/** JSONP */
|
|
3127
|
+
callback?: string;
|
|
3128
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3129
|
+
fields?: string;
|
|
3130
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3131
|
+
key?: string;
|
|
3132
|
+
/** OAuth 2.0 token for the current user. */
|
|
3133
|
+
oauth_token?: string;
|
|
3134
|
+
/** Returns response with indentations and line breaks. */
|
|
3135
|
+
prettyPrint?: boolean;
|
|
3136
|
+
/** 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. */
|
|
3137
|
+
quotaUser?: string;
|
|
3138
|
+
/** Required. The session in which the read should be performed. */
|
|
3139
|
+
session: string;
|
|
3140
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3141
|
+
upload_protocol?: string;
|
|
3142
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3143
|
+
uploadType?: string;
|
|
3144
|
+
},
|
|
3145
|
+
body: ReadRequest): Request<ResultSet>;
|
|
3146
|
+
/**
|
|
3147
|
+
* 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
|
|
3148
|
+
* 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
|
|
3149
|
+
* returns `ABORTED`.
|
|
3150
|
+
*/
|
|
3151
|
+
rollback(request: {
|
|
3152
|
+
/** V1 error format. */
|
|
3153
|
+
"$.xgafv"?: string;
|
|
3154
|
+
/** OAuth access token. */
|
|
3155
|
+
access_token?: string;
|
|
3156
|
+
/** Data format for response. */
|
|
3157
|
+
alt?: string;
|
|
3158
|
+
/** JSONP */
|
|
3159
|
+
callback?: string;
|
|
3160
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3161
|
+
fields?: string;
|
|
3162
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3163
|
+
key?: string;
|
|
3164
|
+
/** OAuth 2.0 token for the current user. */
|
|
3165
|
+
oauth_token?: string;
|
|
3166
|
+
/** Returns response with indentations and line breaks. */
|
|
3167
|
+
prettyPrint?: boolean;
|
|
3168
|
+
/** 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. */
|
|
3169
|
+
quotaUser?: string;
|
|
3170
|
+
/** Required. The session in which the transaction to roll back is running. */
|
|
3171
|
+
session: string;
|
|
3172
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3173
|
+
upload_protocol?: string;
|
|
3174
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3175
|
+
uploadType?: string;
|
|
3176
|
+
/** Request body */
|
|
3177
|
+
resource: RollbackRequest;
|
|
3178
|
+
}): Request<{}>;
|
|
3179
|
+
rollback(request: {
|
|
3180
|
+
/** V1 error format. */
|
|
3181
|
+
"$.xgafv"?: string;
|
|
3182
|
+
/** OAuth access token. */
|
|
3183
|
+
access_token?: string;
|
|
3184
|
+
/** Data format for response. */
|
|
3185
|
+
alt?: string;
|
|
3186
|
+
/** JSONP */
|
|
3187
|
+
callback?: string;
|
|
3188
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3189
|
+
fields?: string;
|
|
3190
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3191
|
+
key?: string;
|
|
3192
|
+
/** OAuth 2.0 token for the current user. */
|
|
3193
|
+
oauth_token?: string;
|
|
3194
|
+
/** Returns response with indentations and line breaks. */
|
|
3195
|
+
prettyPrint?: boolean;
|
|
3196
|
+
/** 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. */
|
|
3197
|
+
quotaUser?: string;
|
|
3198
|
+
/** Required. The session in which the transaction to roll back is running. */
|
|
3199
|
+
session: string;
|
|
3200
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3201
|
+
upload_protocol?: string;
|
|
3202
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3203
|
+
uploadType?: string;
|
|
3204
|
+
},
|
|
3205
|
+
body: RollbackRequest): Request<{}>;
|
|
3206
|
+
/**
|
|
3207
|
+
* 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
|
|
3208
|
+
* 100 MiB, and no column value can exceed 10 MiB.
|
|
3209
|
+
*/
|
|
3210
|
+
streamingRead(request: {
|
|
3211
|
+
/** V1 error format. */
|
|
3212
|
+
"$.xgafv"?: string;
|
|
3213
|
+
/** OAuth access token. */
|
|
3214
|
+
access_token?: string;
|
|
3215
|
+
/** Data format for response. */
|
|
3216
|
+
alt?: string;
|
|
3217
|
+
/** JSONP */
|
|
3218
|
+
callback?: string;
|
|
3219
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3220
|
+
fields?: string;
|
|
3221
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3222
|
+
key?: string;
|
|
3223
|
+
/** OAuth 2.0 token for the current user. */
|
|
3224
|
+
oauth_token?: string;
|
|
3225
|
+
/** Returns response with indentations and line breaks. */
|
|
3226
|
+
prettyPrint?: boolean;
|
|
3227
|
+
/** 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. */
|
|
3228
|
+
quotaUser?: string;
|
|
3229
|
+
/** Required. The session in which the read should be performed. */
|
|
3230
|
+
session: string;
|
|
3231
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3232
|
+
upload_protocol?: string;
|
|
3233
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3234
|
+
uploadType?: string;
|
|
3235
|
+
/** Request body */
|
|
3236
|
+
resource: ReadRequest;
|
|
3237
|
+
}): Request<PartialResultSet>;
|
|
3238
|
+
streamingRead(request: {
|
|
3239
|
+
/** V1 error format. */
|
|
3240
|
+
"$.xgafv"?: string;
|
|
3241
|
+
/** OAuth access token. */
|
|
3242
|
+
access_token?: string;
|
|
3243
|
+
/** Data format for response. */
|
|
3244
|
+
alt?: string;
|
|
3245
|
+
/** JSONP */
|
|
3246
|
+
callback?: string;
|
|
3247
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3248
|
+
fields?: string;
|
|
3249
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3250
|
+
key?: string;
|
|
3251
|
+
/** OAuth 2.0 token for the current user. */
|
|
3252
|
+
oauth_token?: string;
|
|
3253
|
+
/** Returns response with indentations and line breaks. */
|
|
3254
|
+
prettyPrint?: boolean;
|
|
3255
|
+
/** 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. */
|
|
3256
|
+
quotaUser?: string;
|
|
3257
|
+
/** Required. The session in which the read should be performed. */
|
|
3258
|
+
session: string;
|
|
3259
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3260
|
+
upload_protocol?: string;
|
|
3261
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3262
|
+
uploadType?: string;
|
|
3263
|
+
},
|
|
3264
|
+
body: ReadRequest): Request<PartialResultSet>;
|
|
3265
|
+
}
|
|
3266
|
+
interface DatabasesResource {
|
|
3267
|
+
/**
|
|
3268
|
+
* Creates a new Cloud 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
|
|
3269
|
+
* preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
|
|
3270
|
+
*/
|
|
3271
|
+
create(request: {
|
|
3272
|
+
/** V1 error format. */
|
|
3273
|
+
"$.xgafv"?: string;
|
|
3274
|
+
/** OAuth access token. */
|
|
3275
|
+
access_token?: string;
|
|
3276
|
+
/** Data format for response. */
|
|
3277
|
+
alt?: string;
|
|
3278
|
+
/** JSONP */
|
|
3279
|
+
callback?: string;
|
|
3280
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3281
|
+
fields?: string;
|
|
3282
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3283
|
+
key?: string;
|
|
3284
|
+
/** OAuth 2.0 token for the current user. */
|
|
3285
|
+
oauth_token?: string;
|
|
3286
|
+
/** Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. */
|
|
3287
|
+
parent: string;
|
|
3288
|
+
/** Returns response with indentations and line breaks. */
|
|
3289
|
+
prettyPrint?: boolean;
|
|
3290
|
+
/** 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. */
|
|
3291
|
+
quotaUser?: string;
|
|
3292
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3293
|
+
upload_protocol?: string;
|
|
3294
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3295
|
+
uploadType?: string;
|
|
3296
|
+
/** Request body */
|
|
3297
|
+
resource: CreateDatabaseRequest;
|
|
3298
|
+
}): Request<Operation>;
|
|
3299
|
+
create(request: {
|
|
3300
|
+
/** V1 error format. */
|
|
3301
|
+
"$.xgafv"?: string;
|
|
3302
|
+
/** OAuth access token. */
|
|
3303
|
+
access_token?: string;
|
|
3304
|
+
/** Data format for response. */
|
|
3305
|
+
alt?: string;
|
|
3306
|
+
/** JSONP */
|
|
3307
|
+
callback?: string;
|
|
3308
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3309
|
+
fields?: string;
|
|
3310
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3311
|
+
key?: string;
|
|
3312
|
+
/** OAuth 2.0 token for the current user. */
|
|
3313
|
+
oauth_token?: string;
|
|
3314
|
+
/** Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. */
|
|
3315
|
+
parent: string;
|
|
3316
|
+
/** Returns response with indentations and line breaks. */
|
|
3317
|
+
prettyPrint?: boolean;
|
|
3318
|
+
/** 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. */
|
|
3319
|
+
quotaUser?: string;
|
|
3320
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3321
|
+
upload_protocol?: string;
|
|
3322
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3323
|
+
uploadType?: string;
|
|
3324
|
+
},
|
|
3325
|
+
body: CreateDatabaseRequest): Request<Operation>;
|
|
3326
|
+
/**
|
|
3327
|
+
* 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
|
|
3328
|
+
* requests for a few seconds after the database has been deleted.
|
|
3329
|
+
*/
|
|
3330
|
+
dropDatabase(request?: {
|
|
3331
|
+
/** V1 error format. */
|
|
3332
|
+
"$.xgafv"?: string;
|
|
3333
|
+
/** OAuth access token. */
|
|
3334
|
+
access_token?: string;
|
|
3335
|
+
/** Data format for response. */
|
|
3336
|
+
alt?: string;
|
|
3337
|
+
/** JSONP */
|
|
3338
|
+
callback?: string;
|
|
3339
|
+
/** Required. The database to be dropped. */
|
|
3340
|
+
database: string;
|
|
3341
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3342
|
+
fields?: string;
|
|
3343
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3344
|
+
key?: string;
|
|
3345
|
+
/** OAuth 2.0 token for the current user. */
|
|
3346
|
+
oauth_token?: string;
|
|
3347
|
+
/** Returns response with indentations and line breaks. */
|
|
3348
|
+
prettyPrint?: boolean;
|
|
3349
|
+
/** 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. */
|
|
3350
|
+
quotaUser?: string;
|
|
3351
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3352
|
+
upload_protocol?: string;
|
|
3353
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3354
|
+
uploadType?: string;
|
|
3355
|
+
}): Request<{}>;
|
|
3356
|
+
/** Gets the state of a Cloud Spanner database. */
|
|
3357
|
+
get(request?: {
|
|
3358
|
+
/** V1 error format. */
|
|
3359
|
+
"$.xgafv"?: string;
|
|
3360
|
+
/** OAuth access token. */
|
|
3361
|
+
access_token?: string;
|
|
3362
|
+
/** Data format for response. */
|
|
3363
|
+
alt?: string;
|
|
3364
|
+
/** JSONP */
|
|
3365
|
+
callback?: string;
|
|
3366
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3367
|
+
fields?: string;
|
|
3368
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3369
|
+
key?: string;
|
|
3370
|
+
/** Required. The name of the requested database. Values are of the form `projects//instances//databases/`. */
|
|
3371
|
+
name: string;
|
|
3372
|
+
/** OAuth 2.0 token for the current user. */
|
|
3373
|
+
oauth_token?: string;
|
|
3374
|
+
/** Returns response with indentations and line breaks. */
|
|
3375
|
+
prettyPrint?: boolean;
|
|
3376
|
+
/** 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. */
|
|
3377
|
+
quotaUser?: string;
|
|
3378
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3379
|
+
upload_protocol?: string;
|
|
3380
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3381
|
+
uploadType?: string;
|
|
3382
|
+
}): Request<Database>;
|
|
3383
|
+
/**
|
|
3384
|
+
* Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations
|
|
3385
|
+
* API.
|
|
3386
|
+
*/
|
|
3387
|
+
getDdl(request?: {
|
|
3388
|
+
/** V1 error format. */
|
|
3389
|
+
"$.xgafv"?: string;
|
|
3390
|
+
/** OAuth access token. */
|
|
3391
|
+
access_token?: string;
|
|
3392
|
+
/** Data format for response. */
|
|
3393
|
+
alt?: string;
|
|
3394
|
+
/** JSONP */
|
|
3395
|
+
callback?: string;
|
|
3396
|
+
/** Required. The database whose schema we wish to get. Values are of the form `projects//instances//databases/` */
|
|
3397
|
+
database: string;
|
|
3398
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3399
|
+
fields?: string;
|
|
3400
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3401
|
+
key?: string;
|
|
3402
|
+
/** OAuth 2.0 token for the current user. */
|
|
3403
|
+
oauth_token?: string;
|
|
3404
|
+
/** Returns response with indentations and line breaks. */
|
|
3405
|
+
prettyPrint?: boolean;
|
|
3406
|
+
/** 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. */
|
|
3407
|
+
quotaUser?: string;
|
|
3408
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3409
|
+
upload_protocol?: string;
|
|
3410
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3411
|
+
uploadType?: string;
|
|
3412
|
+
}): Request<GetDatabaseDdlResponse>;
|
|
3413
|
+
/**
|
|
3414
|
+
* Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires
|
|
3415
|
+
* `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
|
|
3416
|
+
*/
|
|
3417
|
+
getIamPolicy(request: {
|
|
3418
|
+
/** V1 error format. */
|
|
3419
|
+
"$.xgafv"?: string;
|
|
3420
|
+
/** OAuth access token. */
|
|
3421
|
+
access_token?: string;
|
|
3422
|
+
/** Data format for response. */
|
|
3423
|
+
alt?: string;
|
|
3424
|
+
/** JSONP */
|
|
3425
|
+
callback?: string;
|
|
3426
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3427
|
+
fields?: string;
|
|
3428
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3429
|
+
key?: string;
|
|
3430
|
+
/** OAuth 2.0 token for the current user. */
|
|
3431
|
+
oauth_token?: string;
|
|
3432
|
+
/** Returns response with indentations and line breaks. */
|
|
3433
|
+
prettyPrint?: boolean;
|
|
3434
|
+
/** 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. */
|
|
3435
|
+
quotaUser?: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
3438
|
+
* for database resources.
|
|
3439
|
+
*/
|
|
3440
|
+
resource: string;
|
|
3441
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3442
|
+
upload_protocol?: string;
|
|
3443
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3444
|
+
uploadType?: string;
|
|
3445
|
+
},
|
|
3446
|
+
body: GetIamPolicyRequest): Request<Policy>;
|
|
3447
|
+
/** Request a specific scan with Database-specific data for Cloud Key Visualizer. */
|
|
3448
|
+
getScans(request?: {
|
|
3449
|
+
/** V1 error format. */
|
|
3450
|
+
"$.xgafv"?: string;
|
|
3451
|
+
/** OAuth access token. */
|
|
3452
|
+
access_token?: string;
|
|
3453
|
+
/** Data format for response. */
|
|
3454
|
+
alt?: string;
|
|
3455
|
+
/** JSONP */
|
|
3456
|
+
callback?: string;
|
|
3457
|
+
/** The upper bound for the time range to retrieve Scan data for. */
|
|
3458
|
+
endTime?: string;
|
|
3459
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3460
|
+
fields?: string;
|
|
3461
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3462
|
+
key?: string;
|
|
3463
|
+
/** Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface. */
|
|
3464
|
+
name: string;
|
|
3465
|
+
/** OAuth 2.0 token for the current user. */
|
|
3466
|
+
oauth_token?: string;
|
|
3467
|
+
/** Returns response with indentations and line breaks. */
|
|
3468
|
+
prettyPrint?: boolean;
|
|
3469
|
+
/** 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. */
|
|
3470
|
+
quotaUser?: string;
|
|
3471
|
+
/**
|
|
3472
|
+
* These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are
|
|
3473
|
+
* ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.
|
|
3474
|
+
*/
|
|
3475
|
+
startTime?: string;
|
|
3476
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3477
|
+
upload_protocol?: string;
|
|
3478
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3479
|
+
uploadType?: string;
|
|
3480
|
+
/** Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed. */
|
|
3481
|
+
view?: string;
|
|
3482
|
+
}): Request<Scan>;
|
|
3483
|
+
/** Lists Cloud Spanner databases. */
|
|
3484
|
+
list(request?: {
|
|
3485
|
+
/** V1 error format. */
|
|
3486
|
+
"$.xgafv"?: string;
|
|
3487
|
+
/** OAuth access token. */
|
|
3488
|
+
access_token?: string;
|
|
3489
|
+
/** Data format for response. */
|
|
3490
|
+
alt?: string;
|
|
3491
|
+
/** JSONP */
|
|
3492
|
+
callback?: string;
|
|
3493
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3494
|
+
fields?: string;
|
|
3495
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3496
|
+
key?: string;
|
|
3497
|
+
/** OAuth 2.0 token for the current user. */
|
|
3498
|
+
oauth_token?: string;
|
|
3499
|
+
/** Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
3500
|
+
pageSize?: number;
|
|
3501
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse. */
|
|
3502
|
+
pageToken?: string;
|
|
3503
|
+
/** Required. The instance whose databases should be listed. Values are of the form `projects//instances/`. */
|
|
3504
|
+
parent: string;
|
|
3505
|
+
/** Returns response with indentations and line breaks. */
|
|
3506
|
+
prettyPrint?: boolean;
|
|
3507
|
+
/** 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. */
|
|
3508
|
+
quotaUser?: string;
|
|
3509
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3510
|
+
upload_protocol?: string;
|
|
3511
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3512
|
+
uploadType?: string;
|
|
3513
|
+
}): Request<ListDatabasesResponse>;
|
|
3514
|
+
/**
|
|
3515
|
+
* 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
|
|
3516
|
+
* 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
|
|
3517
|
+
* 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
|
|
3518
|
+
* 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
|
|
3519
|
+
* initiated, without waiting for the optimize operation associated with the first restore to complete.
|
|
3520
|
+
*/
|
|
3521
|
+
restore(request: {
|
|
3522
|
+
/** V1 error format. */
|
|
3523
|
+
"$.xgafv"?: string;
|
|
3524
|
+
/** OAuth access token. */
|
|
3525
|
+
access_token?: string;
|
|
3526
|
+
/** Data format for response. */
|
|
3527
|
+
alt?: string;
|
|
3528
|
+
/** JSONP */
|
|
3529
|
+
callback?: string;
|
|
3530
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3531
|
+
fields?: string;
|
|
3532
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3533
|
+
key?: string;
|
|
3534
|
+
/** OAuth 2.0 token for the current user. */
|
|
3535
|
+
oauth_token?: string;
|
|
3536
|
+
/**
|
|
3537
|
+
* Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance
|
|
3538
|
+
* containing the source backup. Values are of the form `projects//instances/`.
|
|
3539
|
+
*/
|
|
3540
|
+
parent: string;
|
|
3541
|
+
/** Returns response with indentations and line breaks. */
|
|
3542
|
+
prettyPrint?: boolean;
|
|
3543
|
+
/** 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. */
|
|
3544
|
+
quotaUser?: string;
|
|
3545
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3546
|
+
upload_protocol?: string;
|
|
3547
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3548
|
+
uploadType?: string;
|
|
3549
|
+
/** Request body */
|
|
3550
|
+
resource: RestoreDatabaseRequest;
|
|
3551
|
+
}): Request<Operation>;
|
|
3552
|
+
restore(request: {
|
|
3553
|
+
/** V1 error format. */
|
|
3554
|
+
"$.xgafv"?: string;
|
|
3555
|
+
/** OAuth access token. */
|
|
3556
|
+
access_token?: string;
|
|
3557
|
+
/** Data format for response. */
|
|
3558
|
+
alt?: string;
|
|
3559
|
+
/** JSONP */
|
|
3560
|
+
callback?: string;
|
|
3561
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3562
|
+
fields?: string;
|
|
3563
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3564
|
+
key?: string;
|
|
3565
|
+
/** OAuth 2.0 token for the current user. */
|
|
3566
|
+
oauth_token?: string;
|
|
3567
|
+
/**
|
|
3568
|
+
* Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance
|
|
3569
|
+
* containing the source backup. Values are of the form `projects//instances/`.
|
|
3570
|
+
*/
|
|
3571
|
+
parent: string;
|
|
3572
|
+
/** Returns response with indentations and line breaks. */
|
|
3573
|
+
prettyPrint?: boolean;
|
|
3574
|
+
/** 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. */
|
|
3575
|
+
quotaUser?: string;
|
|
3576
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3577
|
+
upload_protocol?: string;
|
|
3578
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3579
|
+
uploadType?: string;
|
|
3580
|
+
},
|
|
3581
|
+
body: RestoreDatabaseRequest): Request<Operation>;
|
|
3582
|
+
/**
|
|
3583
|
+
* Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For
|
|
3584
|
+
* backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
|
|
3585
|
+
*/
|
|
3586
|
+
setIamPolicy(request: {
|
|
3587
|
+
/** V1 error format. */
|
|
3588
|
+
"$.xgafv"?: string;
|
|
3589
|
+
/** OAuth access token. */
|
|
3590
|
+
access_token?: string;
|
|
3591
|
+
/** Data format for response. */
|
|
3592
|
+
alt?: string;
|
|
3593
|
+
/** JSONP */
|
|
3594
|
+
callback?: string;
|
|
3595
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3596
|
+
fields?: string;
|
|
3597
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3598
|
+
key?: string;
|
|
3599
|
+
/** OAuth 2.0 token for the current user. */
|
|
3600
|
+
oauth_token?: string;
|
|
3601
|
+
/** Returns response with indentations and line breaks. */
|
|
3602
|
+
prettyPrint?: boolean;
|
|
3603
|
+
/** 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. */
|
|
3604
|
+
quotaUser?: string;
|
|
3605
|
+
/**
|
|
3606
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for
|
|
3607
|
+
* databases resources.
|
|
3608
|
+
*/
|
|
3609
|
+
resource: string;
|
|
3610
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3611
|
+
upload_protocol?: string;
|
|
3612
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3613
|
+
uploadType?: string;
|
|
3614
|
+
},
|
|
3615
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
3616
|
+
/**
|
|
3617
|
+
* 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
|
|
3618
|
+
* 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
|
|
3619
|
+
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
|
|
3620
|
+
*/
|
|
3621
|
+
testIamPermissions(request: {
|
|
3622
|
+
/** V1 error format. */
|
|
3623
|
+
"$.xgafv"?: string;
|
|
3624
|
+
/** OAuth access token. */
|
|
3625
|
+
access_token?: string;
|
|
3626
|
+
/** Data format for response. */
|
|
3627
|
+
alt?: string;
|
|
3628
|
+
/** JSONP */
|
|
3629
|
+
callback?: string;
|
|
3630
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3631
|
+
fields?: string;
|
|
3632
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3633
|
+
key?: string;
|
|
3634
|
+
/** OAuth 2.0 token for the current user. */
|
|
3635
|
+
oauth_token?: string;
|
|
3636
|
+
/** Returns response with indentations and line breaks. */
|
|
3637
|
+
prettyPrint?: boolean;
|
|
3638
|
+
/** 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. */
|
|
3639
|
+
quotaUser?: string;
|
|
3640
|
+
/**
|
|
3641
|
+
* REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
3642
|
+
* for database resources.
|
|
3643
|
+
*/
|
|
3644
|
+
resource: string;
|
|
3645
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3646
|
+
upload_protocol?: string;
|
|
3647
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3648
|
+
uploadType?: string;
|
|
3649
|
+
},
|
|
3650
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
3651
|
+
/**
|
|
3652
|
+
* 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
|
|
3653
|
+
* `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
|
|
3654
|
+
*/
|
|
3655
|
+
updateDdl(request: {
|
|
3656
|
+
/** V1 error format. */
|
|
3657
|
+
"$.xgafv"?: string;
|
|
3658
|
+
/** OAuth access token. */
|
|
3659
|
+
access_token?: string;
|
|
3660
|
+
/** Data format for response. */
|
|
3661
|
+
alt?: string;
|
|
3662
|
+
/** JSONP */
|
|
3663
|
+
callback?: string;
|
|
3664
|
+
/** Required. The database to update. */
|
|
3665
|
+
database: string;
|
|
3666
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3667
|
+
fields?: string;
|
|
3668
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3669
|
+
key?: string;
|
|
3670
|
+
/** OAuth 2.0 token for the current user. */
|
|
3671
|
+
oauth_token?: string;
|
|
3672
|
+
/** Returns response with indentations and line breaks. */
|
|
3673
|
+
prettyPrint?: boolean;
|
|
3674
|
+
/** 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. */
|
|
3675
|
+
quotaUser?: string;
|
|
3676
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3677
|
+
upload_protocol?: string;
|
|
3678
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3679
|
+
uploadType?: string;
|
|
3680
|
+
/** Request body */
|
|
3681
|
+
resource: UpdateDatabaseDdlRequest;
|
|
3682
|
+
}): Request<Operation>;
|
|
3683
|
+
updateDdl(request: {
|
|
3684
|
+
/** V1 error format. */
|
|
3685
|
+
"$.xgafv"?: string;
|
|
3686
|
+
/** OAuth access token. */
|
|
3687
|
+
access_token?: string;
|
|
3688
|
+
/** Data format for response. */
|
|
3689
|
+
alt?: string;
|
|
3690
|
+
/** JSONP */
|
|
3691
|
+
callback?: string;
|
|
3692
|
+
/** Required. The database to update. */
|
|
3693
|
+
database: string;
|
|
3694
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3695
|
+
fields?: string;
|
|
3696
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3697
|
+
key?: string;
|
|
3698
|
+
/** OAuth 2.0 token for the current user. */
|
|
3699
|
+
oauth_token?: string;
|
|
3700
|
+
/** Returns response with indentations and line breaks. */
|
|
3701
|
+
prettyPrint?: boolean;
|
|
3702
|
+
/** 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. */
|
|
3703
|
+
quotaUser?: string;
|
|
3704
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3705
|
+
upload_protocol?: string;
|
|
3706
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3707
|
+
uploadType?: string;
|
|
3708
|
+
},
|
|
3709
|
+
body: UpdateDatabaseDdlRequest): Request<Operation>;
|
|
3710
|
+
databaseRoles: DatabaseRolesResource;
|
|
3711
|
+
operations: OperationsResource;
|
|
3712
|
+
sessions: SessionsResource;
|
|
3713
|
+
}
|
|
3714
|
+
interface OperationsResource {
|
|
3715
|
+
/**
|
|
3716
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
3717
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
3718
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
3719
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
3720
|
+
*/
|
|
3721
|
+
cancel(request?: {
|
|
3722
|
+
/** V1 error format. */
|
|
3723
|
+
"$.xgafv"?: string;
|
|
3724
|
+
/** OAuth access token. */
|
|
3725
|
+
access_token?: string;
|
|
3726
|
+
/** Data format for response. */
|
|
3727
|
+
alt?: string;
|
|
3728
|
+
/** JSONP */
|
|
3729
|
+
callback?: string;
|
|
3730
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3731
|
+
fields?: string;
|
|
3732
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3733
|
+
key?: string;
|
|
3734
|
+
/** The name of the operation resource to be cancelled. */
|
|
3735
|
+
name: string;
|
|
3736
|
+
/** OAuth 2.0 token for the current user. */
|
|
3737
|
+
oauth_token?: string;
|
|
3738
|
+
/** Returns response with indentations and line breaks. */
|
|
3739
|
+
prettyPrint?: boolean;
|
|
3740
|
+
/** 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. */
|
|
3741
|
+
quotaUser?: string;
|
|
3742
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3743
|
+
upload_protocol?: string;
|
|
3744
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3745
|
+
uploadType?: string;
|
|
3746
|
+
}): Request<{}>;
|
|
3747
|
+
/**
|
|
3748
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
|
|
3749
|
+
* support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
3750
|
+
*/
|
|
3751
|
+
delete(request?: {
|
|
3752
|
+
/** V1 error format. */
|
|
3753
|
+
"$.xgafv"?: string;
|
|
3754
|
+
/** OAuth access token. */
|
|
3755
|
+
access_token?: string;
|
|
3756
|
+
/** Data format for response. */
|
|
3757
|
+
alt?: string;
|
|
3758
|
+
/** JSONP */
|
|
3759
|
+
callback?: string;
|
|
3760
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3761
|
+
fields?: string;
|
|
3762
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3763
|
+
key?: string;
|
|
3764
|
+
/** The name of the operation resource to be deleted. */
|
|
3765
|
+
name: string;
|
|
3766
|
+
/** OAuth 2.0 token for the current user. */
|
|
3767
|
+
oauth_token?: string;
|
|
3768
|
+
/** Returns response with indentations and line breaks. */
|
|
3769
|
+
prettyPrint?: boolean;
|
|
3770
|
+
/** 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. */
|
|
3771
|
+
quotaUser?: string;
|
|
3772
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3773
|
+
upload_protocol?: string;
|
|
3774
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3775
|
+
uploadType?: string;
|
|
3776
|
+
}): Request<{}>;
|
|
3777
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
3778
|
+
get(request?: {
|
|
3779
|
+
/** V1 error format. */
|
|
3780
|
+
"$.xgafv"?: string;
|
|
3781
|
+
/** OAuth access token. */
|
|
3782
|
+
access_token?: string;
|
|
3783
|
+
/** Data format for response. */
|
|
3784
|
+
alt?: string;
|
|
3785
|
+
/** JSONP */
|
|
3786
|
+
callback?: string;
|
|
3787
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3788
|
+
fields?: string;
|
|
3789
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3790
|
+
key?: string;
|
|
3791
|
+
/** The name of the operation resource. */
|
|
3792
|
+
name: string;
|
|
3793
|
+
/** OAuth 2.0 token for the current user. */
|
|
3794
|
+
oauth_token?: string;
|
|
3795
|
+
/** Returns response with indentations and line breaks. */
|
|
3796
|
+
prettyPrint?: boolean;
|
|
3797
|
+
/** 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. */
|
|
3798
|
+
quotaUser?: string;
|
|
3799
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3800
|
+
upload_protocol?: string;
|
|
3801
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3802
|
+
uploadType?: string;
|
|
3803
|
+
}): Request<Operation>;
|
|
3804
|
+
/**
|
|
3805
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
3806
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
3807
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
3808
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
3809
|
+
*/
|
|
3810
|
+
list(request?: {
|
|
3811
|
+
/** V1 error format. */
|
|
3812
|
+
"$.xgafv"?: string;
|
|
3813
|
+
/** OAuth access token. */
|
|
3814
|
+
access_token?: string;
|
|
3815
|
+
/** Data format for response. */
|
|
3816
|
+
alt?: string;
|
|
3817
|
+
/** JSONP */
|
|
3818
|
+
callback?: string;
|
|
3819
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3820
|
+
fields?: string;
|
|
3821
|
+
/** The standard list filter. */
|
|
3822
|
+
filter?: string;
|
|
3823
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3824
|
+
key?: string;
|
|
3825
|
+
/** The name of the operation's parent resource. */
|
|
3826
|
+
name: string;
|
|
3827
|
+
/** OAuth 2.0 token for the current user. */
|
|
3828
|
+
oauth_token?: string;
|
|
3829
|
+
/** The standard list page size. */
|
|
3830
|
+
pageSize?: number;
|
|
3831
|
+
/** The standard list page token. */
|
|
3832
|
+
pageToken?: string;
|
|
3833
|
+
/** Returns response with indentations and line breaks. */
|
|
3834
|
+
prettyPrint?: boolean;
|
|
3835
|
+
/** 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. */
|
|
3836
|
+
quotaUser?: string;
|
|
3837
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3838
|
+
upload_protocol?: string;
|
|
3839
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3840
|
+
uploadType?: string;
|
|
3841
|
+
}): Request<ListOperationsResponse>;
|
|
3842
|
+
}
|
|
3843
|
+
interface InstancesResource {
|
|
3844
|
+
/**
|
|
3845
|
+
* Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name
|
|
3846
|
+
* is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable
|
|
3847
|
+
* via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the
|
|
3848
|
+
* instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: *
|
|
3849
|
+
* Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated
|
|
3850
|
+
* resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used
|
|
3851
|
+
* to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.
|
|
3852
|
+
*/
|
|
3853
|
+
create(request: {
|
|
3854
|
+
/** V1 error format. */
|
|
3855
|
+
"$.xgafv"?: string;
|
|
3856
|
+
/** OAuth access token. */
|
|
3857
|
+
access_token?: string;
|
|
3858
|
+
/** Data format for response. */
|
|
3859
|
+
alt?: string;
|
|
3860
|
+
/** JSONP */
|
|
3861
|
+
callback?: string;
|
|
3862
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3863
|
+
fields?: string;
|
|
3864
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3865
|
+
key?: string;
|
|
3866
|
+
/** OAuth 2.0 token for the current user. */
|
|
3867
|
+
oauth_token?: string;
|
|
3868
|
+
/** Required. The name of the project in which to create the instance. Values are of the form `projects/`. */
|
|
3869
|
+
parent: string;
|
|
3870
|
+
/** Returns response with indentations and line breaks. */
|
|
3871
|
+
prettyPrint?: boolean;
|
|
3872
|
+
/** 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. */
|
|
3873
|
+
quotaUser?: string;
|
|
3874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3875
|
+
upload_protocol?: string;
|
|
3876
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3877
|
+
uploadType?: string;
|
|
3878
|
+
/** Request body */
|
|
3879
|
+
resource: CreateInstanceRequest;
|
|
3880
|
+
}): Request<Operation>;
|
|
3881
|
+
create(request: {
|
|
3882
|
+
/** V1 error format. */
|
|
3883
|
+
"$.xgafv"?: string;
|
|
3884
|
+
/** OAuth access token. */
|
|
3885
|
+
access_token?: string;
|
|
3886
|
+
/** Data format for response. */
|
|
3887
|
+
alt?: string;
|
|
3888
|
+
/** JSONP */
|
|
3889
|
+
callback?: string;
|
|
3890
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3891
|
+
fields?: string;
|
|
3892
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3893
|
+
key?: string;
|
|
3894
|
+
/** OAuth 2.0 token for the current user. */
|
|
3895
|
+
oauth_token?: string;
|
|
3896
|
+
/** Required. The name of the project in which to create the instance. Values are of the form `projects/`. */
|
|
3897
|
+
parent: string;
|
|
3898
|
+
/** Returns response with indentations and line breaks. */
|
|
3899
|
+
prettyPrint?: boolean;
|
|
3900
|
+
/** 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. */
|
|
3901
|
+
quotaUser?: string;
|
|
3902
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3903
|
+
upload_protocol?: string;
|
|
3904
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3905
|
+
uploadType?: string;
|
|
3906
|
+
},
|
|
3907
|
+
body: CreateInstanceRequest): Request<Operation>;
|
|
3908
|
+
/**
|
|
3909
|
+
* 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
|
|
3910
|
+
* databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
|
|
3911
|
+
*/
|
|
3912
|
+
delete(request?: {
|
|
3913
|
+
/** V1 error format. */
|
|
3914
|
+
"$.xgafv"?: string;
|
|
3915
|
+
/** OAuth access token. */
|
|
3916
|
+
access_token?: string;
|
|
3917
|
+
/** Data format for response. */
|
|
3918
|
+
alt?: string;
|
|
3919
|
+
/** JSONP */
|
|
3920
|
+
callback?: string;
|
|
3921
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3922
|
+
fields?: string;
|
|
3923
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3924
|
+
key?: string;
|
|
3925
|
+
/** Required. The name of the instance to be deleted. Values are of the form `projects//instances/` */
|
|
3926
|
+
name: string;
|
|
3927
|
+
/** OAuth 2.0 token for the current user. */
|
|
3928
|
+
oauth_token?: string;
|
|
3929
|
+
/** Returns response with indentations and line breaks. */
|
|
3930
|
+
prettyPrint?: boolean;
|
|
3931
|
+
/** 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. */
|
|
3932
|
+
quotaUser?: string;
|
|
3933
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3934
|
+
upload_protocol?: string;
|
|
3935
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3936
|
+
uploadType?: string;
|
|
3937
|
+
}): Request<{}>;
|
|
3938
|
+
/** Gets information about a particular instance. */
|
|
3939
|
+
get(request?: {
|
|
3940
|
+
/** V1 error format. */
|
|
3941
|
+
"$.xgafv"?: string;
|
|
3942
|
+
/** OAuth access token. */
|
|
3943
|
+
access_token?: string;
|
|
3944
|
+
/** Data format for response. */
|
|
3945
|
+
alt?: string;
|
|
3946
|
+
/** JSONP */
|
|
3947
|
+
callback?: string;
|
|
3948
|
+
/** If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned. */
|
|
3949
|
+
fieldMask?: string;
|
|
3950
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3951
|
+
fields?: string;
|
|
3952
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3953
|
+
key?: string;
|
|
3954
|
+
/** Required. The name of the requested instance. Values are of the form `projects//instances/`. */
|
|
3955
|
+
name: string;
|
|
3956
|
+
/** OAuth 2.0 token for the current user. */
|
|
3957
|
+
oauth_token?: string;
|
|
3958
|
+
/** Returns response with indentations and line breaks. */
|
|
3959
|
+
prettyPrint?: boolean;
|
|
3960
|
+
/** 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. */
|
|
3961
|
+
quotaUser?: string;
|
|
3962
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3963
|
+
upload_protocol?: string;
|
|
3964
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3965
|
+
uploadType?: string;
|
|
3966
|
+
}): Request<Instance>;
|
|
3967
|
+
/**
|
|
3968
|
+
* Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires
|
|
3969
|
+
* `spanner.instances.getIamPolicy` on resource.
|
|
3970
|
+
*/
|
|
3971
|
+
getIamPolicy(request: {
|
|
3972
|
+
/** V1 error format. */
|
|
3973
|
+
"$.xgafv"?: string;
|
|
3974
|
+
/** OAuth access token. */
|
|
3975
|
+
access_token?: string;
|
|
3976
|
+
/** Data format for response. */
|
|
3977
|
+
alt?: string;
|
|
3978
|
+
/** JSONP */
|
|
3979
|
+
callback?: string;
|
|
3980
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3981
|
+
fields?: string;
|
|
3982
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3983
|
+
key?: string;
|
|
3984
|
+
/** OAuth 2.0 token for the current user. */
|
|
3985
|
+
oauth_token?: string;
|
|
3986
|
+
/** Returns response with indentations and line breaks. */
|
|
3987
|
+
prettyPrint?: boolean;
|
|
3988
|
+
/** 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. */
|
|
3989
|
+
quotaUser?: string;
|
|
3990
|
+
/**
|
|
3991
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
3992
|
+
* for database resources.
|
|
3993
|
+
*/
|
|
3994
|
+
resource: string;
|
|
3995
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3996
|
+
upload_protocol?: string;
|
|
3997
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3998
|
+
uploadType?: string;
|
|
3999
|
+
},
|
|
4000
|
+
body: GetIamPolicyRequest): Request<Policy>;
|
|
4001
|
+
/** Lists all instances in the given project. */
|
|
4002
|
+
list(request?: {
|
|
4003
|
+
/** V1 error format. */
|
|
4004
|
+
"$.xgafv"?: string;
|
|
4005
|
+
/** OAuth access token. */
|
|
4006
|
+
access_token?: string;
|
|
4007
|
+
/** Data format for response. */
|
|
4008
|
+
alt?: string;
|
|
4009
|
+
/** JSONP */
|
|
4010
|
+
callback?: string;
|
|
4011
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4012
|
+
fields?: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `display_name` * `labels.key` where
|
|
4015
|
+
* key is the name of a label Some examples of using filters are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's name contains the string "howl". *
|
|
4016
|
+
* `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the label "env". * `labels.env:dev` --> The instance has the
|
|
4017
|
+
* label "env" and the value of the label contains the string "dev". * `name:howl labels.env:dev` --> The instance's name contains "howl" and it has the label "env" with its value
|
|
4018
|
+
* containing "dev".
|
|
4019
|
+
*/
|
|
4020
|
+
filter?: string;
|
|
4021
|
+
/** Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse. */
|
|
4022
|
+
instanceDeadline?: string;
|
|
4023
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4024
|
+
key?: string;
|
|
4025
|
+
/** OAuth 2.0 token for the current user. */
|
|
4026
|
+
oauth_token?: string;
|
|
4027
|
+
/** Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */
|
|
4028
|
+
pageSize?: number;
|
|
4029
|
+
/** If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse. */
|
|
4030
|
+
pageToken?: string;
|
|
4031
|
+
/** Required. The name of the project for which a list of instances is requested. Values are of the form `projects/`. */
|
|
4032
|
+
parent: string;
|
|
4033
|
+
/** Returns response with indentations and line breaks. */
|
|
4034
|
+
prettyPrint?: boolean;
|
|
4035
|
+
/** 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. */
|
|
4036
|
+
quotaUser?: string;
|
|
4037
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4038
|
+
upload_protocol?: string;
|
|
4039
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4040
|
+
uploadType?: string;
|
|
4041
|
+
}): Request<ListInstancesResponse>;
|
|
4042
|
+
/**
|
|
4043
|
+
* 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
|
|
4044
|
+
* 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
|
|
4045
|
+
* 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
|
|
4046
|
+
* 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. *
|
|
4047
|
+
* 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
|
|
4048
|
+
* 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
|
|
4049
|
+
* 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
|
|
4050
|
+
* used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires
|
|
4051
|
+
* `spanner.instances.update` permission on the resource name.
|
|
4052
|
+
*/
|
|
4053
|
+
patch(request: {
|
|
4054
|
+
/** V1 error format. */
|
|
4055
|
+
"$.xgafv"?: string;
|
|
4056
|
+
/** OAuth access token. */
|
|
4057
|
+
access_token?: string;
|
|
4058
|
+
/** Data format for response. */
|
|
4059
|
+
alt?: string;
|
|
4060
|
+
/** JSONP */
|
|
4061
|
+
callback?: string;
|
|
4062
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4063
|
+
fields?: string;
|
|
4064
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4065
|
+
key?: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final
|
|
4068
|
+
* segment of the name must be between 2 and 64 characters in length.
|
|
4069
|
+
*/
|
|
4070
|
+
name: string;
|
|
4071
|
+
/** OAuth 2.0 token for the current user. */
|
|
4072
|
+
oauth_token?: string;
|
|
4073
|
+
/** Returns response with indentations and line breaks. */
|
|
4074
|
+
prettyPrint?: boolean;
|
|
4075
|
+
/** 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. */
|
|
4076
|
+
quotaUser?: string;
|
|
4077
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4078
|
+
upload_protocol?: string;
|
|
4079
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4080
|
+
uploadType?: string;
|
|
4081
|
+
/** Request body */
|
|
4082
|
+
resource: UpdateInstanceRequest;
|
|
4083
|
+
}): Request<Operation>;
|
|
4084
|
+
patch(request: {
|
|
4085
|
+
/** V1 error format. */
|
|
4086
|
+
"$.xgafv"?: string;
|
|
4087
|
+
/** OAuth access token. */
|
|
4088
|
+
access_token?: string;
|
|
4089
|
+
/** Data format for response. */
|
|
4090
|
+
alt?: string;
|
|
4091
|
+
/** JSONP */
|
|
4092
|
+
callback?: string;
|
|
4093
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4094
|
+
fields?: string;
|
|
4095
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4096
|
+
key?: string;
|
|
4097
|
+
/**
|
|
4098
|
+
* Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final
|
|
4099
|
+
* segment of the name must be between 2 and 64 characters in length.
|
|
4100
|
+
*/
|
|
4101
|
+
name: string;
|
|
4102
|
+
/** OAuth 2.0 token for the current user. */
|
|
4103
|
+
oauth_token?: string;
|
|
4104
|
+
/** Returns response with indentations and line breaks. */
|
|
4105
|
+
prettyPrint?: boolean;
|
|
4106
|
+
/** 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. */
|
|
4107
|
+
quotaUser?: string;
|
|
4108
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4109
|
+
upload_protocol?: string;
|
|
4110
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4111
|
+
uploadType?: string;
|
|
4112
|
+
},
|
|
4113
|
+
body: UpdateInstanceRequest): Request<Operation>;
|
|
4114
|
+
/** Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource. */
|
|
4115
|
+
setIamPolicy(request: {
|
|
4116
|
+
/** V1 error format. */
|
|
4117
|
+
"$.xgafv"?: string;
|
|
4118
|
+
/** OAuth access token. */
|
|
4119
|
+
access_token?: string;
|
|
4120
|
+
/** Data format for response. */
|
|
4121
|
+
alt?: string;
|
|
4122
|
+
/** JSONP */
|
|
4123
|
+
callback?: string;
|
|
4124
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4125
|
+
fields?: string;
|
|
4126
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4127
|
+
key?: string;
|
|
4128
|
+
/** OAuth 2.0 token for the current user. */
|
|
4129
|
+
oauth_token?: string;
|
|
4130
|
+
/** Returns response with indentations and line breaks. */
|
|
4131
|
+
prettyPrint?: boolean;
|
|
4132
|
+
/** 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. */
|
|
4133
|
+
quotaUser?: string;
|
|
4134
|
+
/**
|
|
4135
|
+
* REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for
|
|
4136
|
+
* databases resources.
|
|
4137
|
+
*/
|
|
4138
|
+
resource: string;
|
|
4139
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4140
|
+
upload_protocol?: string;
|
|
4141
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4142
|
+
uploadType?: string;
|
|
4143
|
+
},
|
|
4144
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
4145
|
+
/**
|
|
4146
|
+
* 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
|
|
4147
|
+
* the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.
|
|
4148
|
+
*/
|
|
4149
|
+
testIamPermissions(request: {
|
|
4150
|
+
/** V1 error format. */
|
|
4151
|
+
"$.xgafv"?: string;
|
|
4152
|
+
/** OAuth access token. */
|
|
4153
|
+
access_token?: string;
|
|
4154
|
+
/** Data format for response. */
|
|
4155
|
+
alt?: string;
|
|
4156
|
+
/** JSONP */
|
|
4157
|
+
callback?: string;
|
|
4158
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4159
|
+
fields?: string;
|
|
4160
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4161
|
+
key?: string;
|
|
4162
|
+
/** OAuth 2.0 token for the current user. */
|
|
4163
|
+
oauth_token?: string;
|
|
4164
|
+
/** Returns response with indentations and line breaks. */
|
|
4165
|
+
prettyPrint?: boolean;
|
|
4166
|
+
/** 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. */
|
|
4167
|
+
quotaUser?: string;
|
|
4168
|
+
/**
|
|
4169
|
+
* REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/`
|
|
4170
|
+
* for database resources.
|
|
4171
|
+
*/
|
|
4172
|
+
resource: string;
|
|
4173
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4174
|
+
upload_protocol?: string;
|
|
4175
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4176
|
+
uploadType?: string;
|
|
4177
|
+
},
|
|
4178
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
4179
|
+
backupOperations: BackupOperationsResource;
|
|
4180
|
+
backups: BackupsResource;
|
|
4181
|
+
databaseOperations: DatabaseOperationsResource;
|
|
4182
|
+
databases: DatabasesResource;
|
|
4183
|
+
operations: OperationsResource;
|
|
4184
|
+
}
|
|
4185
|
+
interface ProjectsResource {
|
|
4186
|
+
instanceConfigs: InstanceConfigsResource;
|
|
4187
|
+
instances: InstancesResource;
|
|
4188
|
+
}
|
|
4189
|
+
interface ScansResource {
|
|
4190
|
+
/** Return available scans given a Database-specific resource name. */
|
|
4191
|
+
list(request?: {
|
|
4192
|
+
/** V1 error format. */
|
|
4193
|
+
"$.xgafv"?: string;
|
|
4194
|
+
/** OAuth access token. */
|
|
4195
|
+
access_token?: string;
|
|
4196
|
+
/** Data format for response. */
|
|
4197
|
+
alt?: string;
|
|
4198
|
+
/** JSONP */
|
|
4199
|
+
callback?: string;
|
|
4200
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4201
|
+
fields?: string;
|
|
4202
|
+
/**
|
|
4203
|
+
* A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for
|
|
4204
|
+
* `data`.
|
|
4205
|
+
*/
|
|
4206
|
+
filter?: string;
|
|
4207
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4208
|
+
key?: string;
|
|
4209
|
+
/** OAuth 2.0 token for the current user. */
|
|
4210
|
+
oauth_token?: string;
|
|
4211
|
+
/** The maximum number of items to return. */
|
|
4212
|
+
pageSize?: number;
|
|
4213
|
+
/** The next_page_token value returned from a previous List request, if any. */
|
|
4214
|
+
pageToken?: string;
|
|
4215
|
+
/** Required. The unique name of the parent resource, specific to the Database service implementing this interface. */
|
|
4216
|
+
parent: string;
|
|
4217
|
+
/** Returns response with indentations and line breaks. */
|
|
4218
|
+
prettyPrint?: boolean;
|
|
4219
|
+
/** 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. */
|
|
4220
|
+
quotaUser?: string;
|
|
4221
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4222
|
+
upload_protocol?: string;
|
|
4223
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4224
|
+
uploadType?: string;
|
|
4225
|
+
/** Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans. */
|
|
4226
|
+
view?: string;
|
|
4227
|
+
}): Request<ListScansResponse>;
|
|
4228
|
+
}
|
|
4229
|
+
|
|
4230
|
+
const projects: ProjectsResource;
|
|
4231
|
+
|
|
4232
|
+
const scans: ScansResource;
|
|
4233
|
+
}
|
|
4234
|
+
}
|