@maxim_mazurok/gapi.client.datamigration-v1 0.0.20220804

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 ADDED
@@ -0,0 +1,1850 @@
1
+ /* Type definitions for non-npm package Database Migration API v1 0.0 */
2
+ // Project: https://cloud.google.com/database-migration/
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://datamigration.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220804
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Database Migration API v1 */
19
+ function load(urlOrObject: "https://datamigration.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "datamigration", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "datamigration", version: "v1", callback: () => any): void;
24
+
25
+ namespace datamigration {
26
+ interface AuditConfig {
27
+ /** The configuration for logging of each type of permission. */
28
+ auditLogConfigs?: AuditLogConfig[];
29
+ /**
30
+ * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all
31
+ * services.
32
+ */
33
+ service?: string;
34
+ }
35
+ interface AuditLogConfig {
36
+ /** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
37
+ exemptedMembers?: string[];
38
+ /** The log type that this config enables. */
39
+ logType?: string;
40
+ }
41
+ interface Binding {
42
+ /**
43
+ * 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`,
44
+ * 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
45
+ * resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
46
+ */
47
+ condition?: Expr;
48
+ /**
49
+ * 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
50
+ * 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
51
+ * account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
52
+ * represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier
53
+ * for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example,
54
+ * `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. *
55
+ * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
56
+ * `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. *
57
+ * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
58
+ * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
59
+ * 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
60
+ * 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
61
+ * the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
62
+ */
63
+ members?: string[];
64
+ /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
65
+ role?: string;
66
+ }
67
+ // tslint:disable-next-line:no-empty-interface
68
+ interface CancelOperationRequest {
69
+ }
70
+ interface CloudSqlConnectionProfile {
71
+ /** Output only. The Cloud SQL instance ID that this connection profile is associated with. */
72
+ cloudSqlId?: string;
73
+ /** Output only. The Cloud SQL database instance's private IP. */
74
+ privateIp?: string;
75
+ /** Output only. The Cloud SQL database instance's public IP. */
76
+ publicIp?: string;
77
+ /** Immutable. Metadata used to create the destination Cloud SQL database. */
78
+ settings?: CloudSqlSettings;
79
+ }
80
+ interface CloudSqlSettings {
81
+ /**
82
+ * The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains
83
+ * so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
84
+ */
85
+ activationPolicy?: string;
86
+ /**
87
+ * [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically
88
+ * adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
89
+ */
90
+ autoStorageIncrease?: boolean;
91
+ /** The KMS key name used for the csql instance. */
92
+ cmekKeyName?: string;
93
+ /** The Cloud SQL default instance level collation. */
94
+ collation?: string;
95
+ /** The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. */
96
+ databaseFlags?: { [P in string]: string };
97
+ /** The database engine type and version. */
98
+ databaseVersion?: string;
99
+ /** The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. */
100
+ dataDiskSizeGb?: string;
101
+ /** The type of storage: `PD_SSD` (default) or `PD_HDD`. */
102
+ dataDiskType?: string;
103
+ /** The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled. */
104
+ ipConfig?: SqlIpConfig;
105
+ /** Input only. Initial root password. */
106
+ rootPassword?: string;
107
+ /** Output only. Indicates If this connection profile root password is stored. */
108
+ rootPasswordSet?: boolean;
109
+ /** The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID` */
110
+ sourceId?: string;
111
+ /** The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. */
112
+ storageAutoResizeLimit?: string;
113
+ /**
114
+ * The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL
115
+ * Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
116
+ */
117
+ tier?: string;
118
+ /**
119
+ * The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
120
+ * Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
121
+ */
122
+ userLabels?: { [P in string]: string };
123
+ /** The Google Cloud Platform zone where your Cloud SQL datdabse instance is located. */
124
+ zone?: string;
125
+ }
126
+ interface ConnectionProfile {
127
+ /** A CloudSQL database connection profile. */
128
+ cloudsql?: CloudSqlConnectionProfile;
129
+ /** Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". */
130
+ createTime?: string;
131
+ /** The connection profile display name. */
132
+ displayName?: string;
133
+ /** Output only. The error details in case of state FAILED. */
134
+ error?: Status;
135
+ /**
136
+ * The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
137
+ * Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
138
+ */
139
+ labels?: { [P in string]: string };
140
+ /** A MySQL database connection profile. */
141
+ mysql?: MySqlConnectionProfile;
142
+ /** The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. */
143
+ name?: string;
144
+ /** A PostgreSQL database connection profile. */
145
+ postgresql?: PostgreSqlConnectionProfile;
146
+ /** The database provider. */
147
+ provider?: string;
148
+ /** The current connection profile state (e.g. DRAFT, READY, or FAILED). */
149
+ state?: string;
150
+ /** Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". */
151
+ updateTime?: string;
152
+ }
153
+ interface DatabaseType {
154
+ /** The database engine. */
155
+ engine?: string;
156
+ /** The database provider. */
157
+ provider?: string;
158
+ }
159
+ interface DumpFlag {
160
+ /** The name of the flag */
161
+ name?: string;
162
+ /** The value of the flag. */
163
+ value?: string;
164
+ }
165
+ interface DumpFlags {
166
+ /** The flags for the initial dump. */
167
+ dumpFlags?: DumpFlag[];
168
+ }
169
+ // tslint:disable-next-line:no-empty-interface
170
+ interface Empty {
171
+ }
172
+ interface Expr {
173
+ /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
174
+ description?: string;
175
+ /** Textual representation of an expression in Common Expression Language syntax. */
176
+ expression?: string;
177
+ /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
178
+ location?: string;
179
+ /** 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. */
180
+ title?: string;
181
+ }
182
+ interface GenerateSshScriptRequest {
183
+ /** Required. Bastion VM Instance name to use or to create. */
184
+ vm?: string;
185
+ /** The VM creation configuration */
186
+ vmCreationConfig?: VmCreationConfig;
187
+ /** The port that will be open on the bastion host */
188
+ vmPort?: number;
189
+ /** The VM selection configuration */
190
+ vmSelectionConfig?: VmSelectionConfig;
191
+ }
192
+ interface GoogleCloudClouddmsV1OperationMetadata {
193
+ /** Output only. API version used to start the operation. */
194
+ apiVersion?: string;
195
+ /** Output only. The time the operation was created. */
196
+ createTime?: string;
197
+ /** Output only. The time the operation finished running. */
198
+ endTime?: string;
199
+ /**
200
+ * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a
201
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
202
+ */
203
+ requestedCancellation?: boolean;
204
+ /** Output only. Human-readable status of the operation, if any. */
205
+ statusMessage?: string;
206
+ /** Output only. Server-defined resource path for the target of the operation. */
207
+ target?: string;
208
+ /** Output only. Name of the verb executed by the operation. */
209
+ verb?: string;
210
+ }
211
+ interface ListConnectionProfilesResponse {
212
+ /** The response list of connection profiles. */
213
+ connectionProfiles?: ConnectionProfile[];
214
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
215
+ nextPageToken?: string;
216
+ /** Locations that could not be reached. */
217
+ unreachable?: string[];
218
+ }
219
+ interface ListLocationsResponse {
220
+ /** A list of locations that matches the specified filter in the request. */
221
+ locations?: Location[];
222
+ /** The standard List next-page token. */
223
+ nextPageToken?: string;
224
+ }
225
+ interface ListMigrationJobsResponse {
226
+ /** The list of migration jobs objects. */
227
+ migrationJobs?: MigrationJob[];
228
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
229
+ nextPageToken?: string;
230
+ /** Locations that could not be reached. */
231
+ unreachable?: string[];
232
+ }
233
+ interface ListOperationsResponse {
234
+ /** The standard List next-page token. */
235
+ nextPageToken?: string;
236
+ /** A list of operations that matches the specified filter in the request. */
237
+ operations?: Operation[];
238
+ }
239
+ interface Location {
240
+ /** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
241
+ displayName?: string;
242
+ /** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
243
+ labels?: { [P in string]: string };
244
+ /** The canonical id for this location. For example: `"us-east1"`. */
245
+ locationId?: string;
246
+ /** Service-specific metadata. For example the available capacity at the given location. */
247
+ metadata?: { [P in string]: any };
248
+ /** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
249
+ name?: string;
250
+ }
251
+ interface MigrationJob {
252
+ /** Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". */
253
+ createTime?: string;
254
+ /** Required. The resource name (URI) of the destination connection profile. */
255
+ destination?: string;
256
+ /** The database engine type and provider of the destination. */
257
+ destinationDatabase?: DatabaseType;
258
+ /** The migration job display name. */
259
+ displayName?: string;
260
+ /** The initial dump flags. This field and the "dump_path" field are mutually exclusive. */
261
+ dumpFlags?: DumpFlags;
262
+ /** The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive. */
263
+ dumpPath?: string;
264
+ /** Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
265
+ duration?: string;
266
+ /** Output only. If the migration job is completed, the time when it was completed. */
267
+ endTime?: string;
268
+ /** Output only. The error details in case of state FAILED. */
269
+ error?: Status;
270
+ /**
271
+ * The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
272
+ * `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
273
+ */
274
+ labels?: { [P in string]: string };
275
+ /** The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. */
276
+ name?: string;
277
+ /** Output only. The current migration job phase. */
278
+ phase?: string;
279
+ /** The details needed to communicate to the source over Reverse SSH tunnel connectivity. */
280
+ reverseSshConnectivity?: ReverseSshConnectivity;
281
+ /** Required. The resource name (URI) of the source connection profile. */
282
+ source?: string;
283
+ /** The database engine type and provider of the source. */
284
+ sourceDatabase?: DatabaseType;
285
+ /** The current migration job state. */
286
+ state?: string;
287
+ /** static ip connectivity data (default, no additional details needed). */
288
+ staticIpConnectivity?: any;
289
+ /** Required. The migration job type. */
290
+ type?: string;
291
+ /**
292
+ * Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example:
293
+ * "2014-10-02T15:01:23.045123456Z".
294
+ */
295
+ updateTime?: string;
296
+ /** The details of the VPC network that the source database is located in. */
297
+ vpcPeeringConnectivity?: VpcPeeringConnectivity;
298
+ }
299
+ interface MigrationJobVerificationError {
300
+ /** Output only. An instance of ErrorCode specifying the error that occurred. */
301
+ errorCode?: string;
302
+ /** Output only. A specific detailed error message, if supplied by the engine. */
303
+ errorDetailMessage?: string;
304
+ /** Output only. A formatted message with further details about the error and a CTA. */
305
+ errorMessage?: string;
306
+ }
307
+ interface MySqlConnectionProfile {
308
+ /** If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. */
309
+ cloudSqlId?: string;
310
+ /** Required. The IP or hostname of the source MySQL database. */
311
+ host?: string;
312
+ /**
313
+ * Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is
314
+ * encrypted when stored in Database Migration Service.
315
+ */
316
+ password?: string;
317
+ /** Output only. Indicates If this connection profile password is stored. */
318
+ passwordSet?: boolean;
319
+ /** Required. The network port of the source MySQL database. */
320
+ port?: number;
321
+ /** SSL configuration for the destination to connect to the source database. */
322
+ ssl?: SslConfig;
323
+ /** Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. */
324
+ username?: string;
325
+ }
326
+ interface Operation {
327
+ /** 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. */
328
+ done?: boolean;
329
+ /** The error result of the operation in case of failure or cancellation. */
330
+ error?: Status;
331
+ /**
332
+ * 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
333
+ * metadata. Any method that returns a long-running operation should document the metadata type, if any.
334
+ */
335
+ metadata?: { [P in string]: any };
336
+ /**
337
+ * 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
338
+ * with `operations/{unique_id}`.
339
+ */
340
+ name?: string;
341
+ /**
342
+ * 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
343
+ * 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
344
+ * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
345
+ */
346
+ response?: { [P in string]: any };
347
+ }
348
+ interface Policy {
349
+ /** Specifies cloud audit logging configuration for this policy. */
350
+ auditConfigs?: AuditConfig[];
351
+ /**
352
+ * 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`
353
+ * 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
354
+ * 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
355
+ * 1,450 principals to the `bindings` in the `Policy`.
356
+ */
357
+ bindings?: Binding[];
358
+ /**
359
+ * `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
360
+ * 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
361
+ * 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
362
+ * 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`
363
+ * policy, and all of the conditions in the version `3` policy are lost.
364
+ */
365
+ etag?: string;
366
+ /**
367
+ * 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
368
+ * 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
369
+ * 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
370
+ * 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`
371
+ * 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
372
+ * 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).
373
+ */
374
+ version?: number;
375
+ }
376
+ interface PostgreSqlConnectionProfile {
377
+ /** If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. */
378
+ cloudSqlId?: string;
379
+ /** Required. The IP or hostname of the source PostgreSQL database. */
380
+ host?: string;
381
+ /**
382
+ * Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is
383
+ * encrypted when stored in Database Migration Service.
384
+ */
385
+ password?: string;
386
+ /** Output only. Indicates If this connection profile password is stored. */
387
+ passwordSet?: boolean;
388
+ /** Required. The network port of the source PostgreSQL database. */
389
+ port?: number;
390
+ /** SSL configuration for the destination to connect to the source database. */
391
+ ssl?: SslConfig;
392
+ /** Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. */
393
+ username?: string;
394
+ }
395
+ // tslint:disable-next-line:no-empty-interface
396
+ interface PromoteMigrationJobRequest {
397
+ }
398
+ // tslint:disable-next-line:no-empty-interface
399
+ interface RestartMigrationJobRequest {
400
+ }
401
+ // tslint:disable-next-line:no-empty-interface
402
+ interface ResumeMigrationJobRequest {
403
+ }
404
+ interface ReverseSshConnectivity {
405
+ /** The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. */
406
+ vm?: string;
407
+ /** Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. */
408
+ vmIp?: string;
409
+ /** Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. */
410
+ vmPort?: number;
411
+ /** The name of the VPC to peer with the Cloud SQL private network. */
412
+ vpc?: string;
413
+ }
414
+ interface SetIamPolicyRequest {
415
+ /**
416
+ * 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
417
+ * services (such as Projects) might reject them.
418
+ */
419
+ policy?: Policy;
420
+ /**
421
+ * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:
422
+ * `paths: "bindings, etag"`
423
+ */
424
+ updateMask?: string;
425
+ }
426
+ interface SqlAclEntry {
427
+ /** The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`. */
428
+ expireTime?: string;
429
+ /** A label to identify this entry. */
430
+ label?: string;
431
+ /** Input only. The time-to-leave of this access control entry. */
432
+ ttl?: string;
433
+ /** The allowlisted value for the access control list. */
434
+ value?: string;
435
+ }
436
+ interface SqlIpConfig {
437
+ /**
438
+ * The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation
439
+ * (e.g. `192.168.100.0/24`).
440
+ */
441
+ authorizedNetworks?: SqlAclEntry[];
442
+ /** Whether the instance should be assigned an IPv4 address or not. */
443
+ enableIpv4?: boolean;
444
+ /**
445
+ * The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `projects/myProject/global/networks/default`. This setting can be
446
+ * updated, but it cannot be removed after it is set.
447
+ */
448
+ privateNetwork?: string;
449
+ /** Whether SSL connections over IP should be enforced or not. */
450
+ requireSsl?: boolean;
451
+ }
452
+ interface SshScript {
453
+ /** The ssh configuration script. */
454
+ script?: string;
455
+ }
456
+ interface SslConfig {
457
+ /**
458
+ * Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's
459
+ * connecting to the right host.
460
+ */
461
+ caCertificate?: string;
462
+ /**
463
+ * Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is
464
+ * mandatory.
465
+ */
466
+ clientCertificate?: string;
467
+ /** Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. */
468
+ clientKey?: string;
469
+ /** Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. */
470
+ type?: string;
471
+ }
472
+ // tslint:disable-next-line:no-empty-interface
473
+ interface StartMigrationJobRequest {
474
+ }
475
+ // tslint:disable-next-line:no-empty-interface
476
+ interface StaticIpConnectivity {
477
+ }
478
+ interface Status {
479
+ /** The status code, which should be an enum value of google.rpc.Code. */
480
+ code?: number;
481
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
482
+ details?: Array<{ [P in string]: any }>;
483
+ /**
484
+ * 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
485
+ * client.
486
+ */
487
+ message?: string;
488
+ }
489
+ // tslint:disable-next-line:no-empty-interface
490
+ interface StopMigrationJobRequest {
491
+ }
492
+ interface TestIamPermissionsRequest {
493
+ /**
494
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
495
+ * Overview](https://cloud.google.com/iam/docs/overview#permissions).
496
+ */
497
+ permissions?: string[];
498
+ }
499
+ interface TestIamPermissionsResponse {
500
+ /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
501
+ permissions?: string[];
502
+ }
503
+ // tslint:disable-next-line:no-empty-interface
504
+ interface VerifyMigrationJobRequest {
505
+ }
506
+ interface VmCreationConfig {
507
+ /** The subnet name the vm needs to be created in. */
508
+ subnet?: string;
509
+ /** Required. VM instance machine type to create. */
510
+ vmMachineType?: string;
511
+ /** The Google Cloud Platform zone to create the VM in. */
512
+ vmZone?: string;
513
+ }
514
+ interface VmSelectionConfig {
515
+ /** Required. The Google Cloud Platform zone the VM is located. */
516
+ vmZone?: string;
517
+ }
518
+ interface VpcPeeringConnectivity {
519
+ /** The name of the VPC network to peer with the Cloud SQL private network. */
520
+ vpc?: string;
521
+ }
522
+ interface ConnectionProfilesResource {
523
+ /** Creates a new connection profile in a given project and location. */
524
+ create(request: {
525
+ /** V1 error format. */
526
+ "$.xgafv"?: string;
527
+ /** OAuth access token. */
528
+ access_token?: string;
529
+ /** Data format for response. */
530
+ alt?: string;
531
+ /** JSONP */
532
+ callback?: string;
533
+ /** Required. The connection profile identifier. */
534
+ connectionProfileId?: string;
535
+ /** Selector specifying which fields to include in a partial response. */
536
+ fields?: string;
537
+ /** 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. */
538
+ key?: string;
539
+ /** OAuth 2.0 token for the current user. */
540
+ oauth_token?: string;
541
+ /** Required. The parent, which owns this collection of connection profiles. */
542
+ parent: string;
543
+ /** Returns response with indentations and line breaks. */
544
+ prettyPrint?: boolean;
545
+ /** 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. */
546
+ quotaUser?: string;
547
+ /**
548
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
549
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
550
+ */
551
+ requestId?: string;
552
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
553
+ upload_protocol?: string;
554
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
555
+ uploadType?: string;
556
+ /** Request body */
557
+ resource: ConnectionProfile;
558
+ }): Request<Operation>;
559
+ create(request: {
560
+ /** V1 error format. */
561
+ "$.xgafv"?: string;
562
+ /** OAuth access token. */
563
+ access_token?: string;
564
+ /** Data format for response. */
565
+ alt?: string;
566
+ /** JSONP */
567
+ callback?: string;
568
+ /** Required. The connection profile identifier. */
569
+ connectionProfileId?: string;
570
+ /** Selector specifying which fields to include in a partial response. */
571
+ fields?: string;
572
+ /** 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. */
573
+ key?: string;
574
+ /** OAuth 2.0 token for the current user. */
575
+ oauth_token?: string;
576
+ /** Required. The parent, which owns this collection of connection profiles. */
577
+ parent: string;
578
+ /** Returns response with indentations and line breaks. */
579
+ prettyPrint?: boolean;
580
+ /** 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. */
581
+ quotaUser?: string;
582
+ /**
583
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
584
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
585
+ */
586
+ requestId?: string;
587
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
588
+ upload_protocol?: string;
589
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
590
+ uploadType?: string;
591
+ },
592
+ body: ConnectionProfile): Request<Operation>;
593
+ /** Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs. */
594
+ delete(request?: {
595
+ /** V1 error format. */
596
+ "$.xgafv"?: string;
597
+ /** OAuth access token. */
598
+ access_token?: string;
599
+ /** Data format for response. */
600
+ alt?: string;
601
+ /** JSONP */
602
+ callback?: string;
603
+ /** Selector specifying which fields to include in a partial response. */
604
+ fields?: string;
605
+ /** In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile). */
606
+ force?: boolean;
607
+ /** 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. */
608
+ key?: string;
609
+ /** Required. Name of the connection profile resource to delete. */
610
+ name: string;
611
+ /** OAuth 2.0 token for the current user. */
612
+ oauth_token?: string;
613
+ /** Returns response with indentations and line breaks. */
614
+ prettyPrint?: boolean;
615
+ /** 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. */
616
+ quotaUser?: string;
617
+ /**
618
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
619
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
620
+ */
621
+ requestId?: string;
622
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
623
+ upload_protocol?: string;
624
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
625
+ uploadType?: string;
626
+ }): Request<Operation>;
627
+ /** Gets details of a single connection profile. */
628
+ get(request?: {
629
+ /** V1 error format. */
630
+ "$.xgafv"?: string;
631
+ /** OAuth access token. */
632
+ access_token?: string;
633
+ /** Data format for response. */
634
+ alt?: string;
635
+ /** JSONP */
636
+ callback?: string;
637
+ /** Selector specifying which fields to include in a partial response. */
638
+ fields?: string;
639
+ /** 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. */
640
+ key?: string;
641
+ /** Required. Name of the connection profile resource to get. */
642
+ name: string;
643
+ /** OAuth 2.0 token for the current user. */
644
+ oauth_token?: string;
645
+ /** Returns response with indentations and line breaks. */
646
+ prettyPrint?: boolean;
647
+ /** 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. */
648
+ quotaUser?: string;
649
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
650
+ upload_protocol?: string;
651
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
652
+ uploadType?: string;
653
+ }): Request<ConnectionProfile>;
654
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
655
+ getIamPolicy(request?: {
656
+ /** V1 error format. */
657
+ "$.xgafv"?: string;
658
+ /** OAuth access token. */
659
+ access_token?: string;
660
+ /** Data format for response. */
661
+ alt?: string;
662
+ /** JSONP */
663
+ callback?: string;
664
+ /** Selector specifying which fields to include in a partial response. */
665
+ fields?: string;
666
+ /** 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. */
667
+ key?: string;
668
+ /** OAuth 2.0 token for the current user. */
669
+ oauth_token?: string;
670
+ /**
671
+ * 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
672
+ * 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
673
+ * in 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
674
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
675
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
676
+ */
677
+ "options.requestedPolicyVersion"?: number;
678
+ /** Returns response with indentations and line breaks. */
679
+ prettyPrint?: boolean;
680
+ /** 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. */
681
+ quotaUser?: string;
682
+ /**
683
+ * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
684
+ * field.
685
+ */
686
+ resource: string;
687
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
688
+ upload_protocol?: string;
689
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
690
+ uploadType?: string;
691
+ }): Request<Policy>;
692
+ /** Retrieves a list of all connection profiles in a given project and location. */
693
+ list(request?: {
694
+ /** V1 error format. */
695
+ "$.xgafv"?: string;
696
+ /** OAuth access token. */
697
+ access_token?: string;
698
+ /** Data format for response. */
699
+ alt?: string;
700
+ /** JSONP */
701
+ callback?: string;
702
+ /** Selector specifying which fields to include in a partial response. */
703
+ fields?: string;
704
+ /**
705
+ * A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to
706
+ * use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this
707
+ * year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can also filter nested fields. For example, you could specify **mySql.username = %lt;my_username%gt;**
708
+ * to list all connection profiles configured to connect with a specific username.
709
+ */
710
+ filter?: string;
711
+ /** 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. */
712
+ key?: string;
713
+ /** OAuth 2.0 token for the current user. */
714
+ oauth_token?: string;
715
+ /** A comma-separated list of fields to order results according to. */
716
+ orderBy?: string;
717
+ /**
718
+ * The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum
719
+ * value is 1000; values above 1000 will be coerced to 1000.
720
+ */
721
+ pageSize?: number;
722
+ /**
723
+ * A page token, received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
724
+ * `ListConnectionProfiles` must match the call that provided the page token.
725
+ */
726
+ pageToken?: string;
727
+ /** Required. The parent, which owns this collection of connection profiles. */
728
+ parent: string;
729
+ /** Returns response with indentations and line breaks. */
730
+ prettyPrint?: boolean;
731
+ /** 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. */
732
+ quotaUser?: string;
733
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
734
+ upload_protocol?: string;
735
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
736
+ uploadType?: string;
737
+ }): Request<ListConnectionProfilesResponse>;
738
+ /** Update the configuration of a single connection profile. */
739
+ patch(request: {
740
+ /** V1 error format. */
741
+ "$.xgafv"?: string;
742
+ /** OAuth access token. */
743
+ access_token?: string;
744
+ /** Data format for response. */
745
+ alt?: string;
746
+ /** JSONP */
747
+ callback?: string;
748
+ /** Selector specifying which fields to include in a partial response. */
749
+ fields?: string;
750
+ /** 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. */
751
+ key?: string;
752
+ /** The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. */
753
+ name: string;
754
+ /** OAuth 2.0 token for the current user. */
755
+ oauth_token?: string;
756
+ /** Returns response with indentations and line breaks. */
757
+ prettyPrint?: boolean;
758
+ /** 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. */
759
+ quotaUser?: string;
760
+ /**
761
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
762
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
763
+ */
764
+ requestId?: string;
765
+ /** Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update. */
766
+ updateMask?: string;
767
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
768
+ upload_protocol?: string;
769
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
770
+ uploadType?: string;
771
+ /** Request body */
772
+ resource: ConnectionProfile;
773
+ }): Request<Operation>;
774
+ patch(request: {
775
+ /** V1 error format. */
776
+ "$.xgafv"?: string;
777
+ /** OAuth access token. */
778
+ access_token?: string;
779
+ /** Data format for response. */
780
+ alt?: string;
781
+ /** JSONP */
782
+ callback?: string;
783
+ /** Selector specifying which fields to include in a partial response. */
784
+ fields?: string;
785
+ /** 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. */
786
+ key?: string;
787
+ /** The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. */
788
+ name: string;
789
+ /** OAuth 2.0 token for the current user. */
790
+ oauth_token?: string;
791
+ /** Returns response with indentations and line breaks. */
792
+ prettyPrint?: boolean;
793
+ /** 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. */
794
+ quotaUser?: string;
795
+ /**
796
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
797
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
798
+ */
799
+ requestId?: string;
800
+ /** Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update. */
801
+ updateMask?: string;
802
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
803
+ upload_protocol?: string;
804
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
805
+ uploadType?: string;
806
+ },
807
+ body: ConnectionProfile): Request<Operation>;
808
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
809
+ setIamPolicy(request: {
810
+ /** V1 error format. */
811
+ "$.xgafv"?: string;
812
+ /** OAuth access token. */
813
+ access_token?: string;
814
+ /** Data format for response. */
815
+ alt?: string;
816
+ /** JSONP */
817
+ callback?: string;
818
+ /** Selector specifying which fields to include in a partial response. */
819
+ fields?: string;
820
+ /** 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. */
821
+ key?: string;
822
+ /** OAuth 2.0 token for the current user. */
823
+ oauth_token?: string;
824
+ /** Returns response with indentations and line breaks. */
825
+ prettyPrint?: boolean;
826
+ /** 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. */
827
+ quotaUser?: string;
828
+ /**
829
+ * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
830
+ * field.
831
+ */
832
+ resource: string;
833
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
834
+ upload_protocol?: string;
835
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
836
+ uploadType?: string;
837
+ },
838
+ body: SetIamPolicyRequest): Request<Policy>;
839
+ /**
840
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
841
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
842
+ */
843
+ testIamPermissions(request: {
844
+ /** V1 error format. */
845
+ "$.xgafv"?: string;
846
+ /** OAuth access token. */
847
+ access_token?: string;
848
+ /** Data format for response. */
849
+ alt?: string;
850
+ /** JSONP */
851
+ callback?: string;
852
+ /** Selector specifying which fields to include in a partial response. */
853
+ fields?: string;
854
+ /** 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. */
855
+ key?: string;
856
+ /** OAuth 2.0 token for the current user. */
857
+ oauth_token?: string;
858
+ /** Returns response with indentations and line breaks. */
859
+ prettyPrint?: boolean;
860
+ /** 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. */
861
+ quotaUser?: string;
862
+ /**
863
+ * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
864
+ * this field.
865
+ */
866
+ resource: string;
867
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
868
+ upload_protocol?: string;
869
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
870
+ uploadType?: string;
871
+ },
872
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
873
+ }
874
+ interface MigrationJobsResource {
875
+ /** Creates a new migration job in a given project and location. */
876
+ create(request: {
877
+ /** V1 error format. */
878
+ "$.xgafv"?: string;
879
+ /** OAuth access token. */
880
+ access_token?: string;
881
+ /** Data format for response. */
882
+ alt?: string;
883
+ /** JSONP */
884
+ callback?: string;
885
+ /** Selector specifying which fields to include in a partial response. */
886
+ fields?: string;
887
+ /** 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. */
888
+ key?: string;
889
+ /** Required. The ID of the instance to create. */
890
+ migrationJobId?: string;
891
+ /** OAuth 2.0 token for the current user. */
892
+ oauth_token?: string;
893
+ /** Required. The parent, which owns this collection of migration jobs. */
894
+ parent: string;
895
+ /** Returns response with indentations and line breaks. */
896
+ prettyPrint?: boolean;
897
+ /** 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. */
898
+ quotaUser?: string;
899
+ /**
900
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
901
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
902
+ */
903
+ requestId?: string;
904
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
905
+ upload_protocol?: string;
906
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
907
+ uploadType?: string;
908
+ /** Request body */
909
+ resource: MigrationJob;
910
+ }): Request<Operation>;
911
+ create(request: {
912
+ /** V1 error format. */
913
+ "$.xgafv"?: string;
914
+ /** OAuth access token. */
915
+ access_token?: string;
916
+ /** Data format for response. */
917
+ alt?: string;
918
+ /** JSONP */
919
+ callback?: string;
920
+ /** Selector specifying which fields to include in a partial response. */
921
+ fields?: string;
922
+ /** 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. */
923
+ key?: string;
924
+ /** Required. The ID of the instance to create. */
925
+ migrationJobId?: string;
926
+ /** OAuth 2.0 token for the current user. */
927
+ oauth_token?: string;
928
+ /** Required. The parent, which owns this collection of migration jobs. */
929
+ parent: string;
930
+ /** Returns response with indentations and line breaks. */
931
+ prettyPrint?: boolean;
932
+ /** 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. */
933
+ quotaUser?: string;
934
+ /**
935
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
936
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
937
+ */
938
+ requestId?: string;
939
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
940
+ upload_protocol?: string;
941
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
942
+ uploadType?: string;
943
+ },
944
+ body: MigrationJob): Request<Operation>;
945
+ /** Deletes a single migration job. */
946
+ delete(request?: {
947
+ /** V1 error format. */
948
+ "$.xgafv"?: string;
949
+ /** OAuth access token. */
950
+ access_token?: string;
951
+ /** Data format for response. */
952
+ alt?: string;
953
+ /** JSONP */
954
+ callback?: string;
955
+ /** Selector specifying which fields to include in a partial response. */
956
+ fields?: string;
957
+ /** The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted. */
958
+ force?: boolean;
959
+ /** 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. */
960
+ key?: string;
961
+ /** Required. Name of the migration job resource to delete. */
962
+ name: string;
963
+ /** OAuth 2.0 token for the current user. */
964
+ oauth_token?: string;
965
+ /** Returns response with indentations and line breaks. */
966
+ prettyPrint?: boolean;
967
+ /** 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. */
968
+ quotaUser?: string;
969
+ /**
970
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
971
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
972
+ */
973
+ requestId?: string;
974
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
975
+ upload_protocol?: string;
976
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
977
+ uploadType?: string;
978
+ }): Request<Operation>;
979
+ /** Generate a SSH configuration script to configure the reverse SSH connectivity. */
980
+ generateSshScript(request: {
981
+ /** V1 error format. */
982
+ "$.xgafv"?: string;
983
+ /** OAuth access token. */
984
+ access_token?: string;
985
+ /** Data format for response. */
986
+ alt?: string;
987
+ /** JSONP */
988
+ callback?: string;
989
+ /** Selector specifying which fields to include in a partial response. */
990
+ fields?: string;
991
+ /** 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. */
992
+ key?: string;
993
+ /** Name of the migration job resource to generate the SSH script. */
994
+ migrationJob: string;
995
+ /** OAuth 2.0 token for the current user. */
996
+ oauth_token?: string;
997
+ /** Returns response with indentations and line breaks. */
998
+ prettyPrint?: boolean;
999
+ /** 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. */
1000
+ quotaUser?: string;
1001
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1002
+ upload_protocol?: string;
1003
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1004
+ uploadType?: string;
1005
+ /** Request body */
1006
+ resource: GenerateSshScriptRequest;
1007
+ }): Request<SshScript>;
1008
+ generateSshScript(request: {
1009
+ /** V1 error format. */
1010
+ "$.xgafv"?: string;
1011
+ /** OAuth access token. */
1012
+ access_token?: string;
1013
+ /** Data format for response. */
1014
+ alt?: string;
1015
+ /** JSONP */
1016
+ callback?: string;
1017
+ /** Selector specifying which fields to include in a partial response. */
1018
+ fields?: string;
1019
+ /** 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. */
1020
+ key?: string;
1021
+ /** Name of the migration job resource to generate the SSH script. */
1022
+ migrationJob: string;
1023
+ /** OAuth 2.0 token for the current user. */
1024
+ oauth_token?: string;
1025
+ /** Returns response with indentations and line breaks. */
1026
+ prettyPrint?: boolean;
1027
+ /** 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. */
1028
+ quotaUser?: string;
1029
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1030
+ upload_protocol?: string;
1031
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1032
+ uploadType?: string;
1033
+ },
1034
+ body: GenerateSshScriptRequest): Request<SshScript>;
1035
+ /** Gets details of a single migration job. */
1036
+ get(request?: {
1037
+ /** V1 error format. */
1038
+ "$.xgafv"?: string;
1039
+ /** OAuth access token. */
1040
+ access_token?: string;
1041
+ /** Data format for response. */
1042
+ alt?: string;
1043
+ /** JSONP */
1044
+ callback?: string;
1045
+ /** Selector specifying which fields to include in a partial response. */
1046
+ fields?: string;
1047
+ /** 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. */
1048
+ key?: string;
1049
+ /** Required. Name of the migration job resource to get. */
1050
+ name: string;
1051
+ /** OAuth 2.0 token for the current user. */
1052
+ oauth_token?: string;
1053
+ /** Returns response with indentations and line breaks. */
1054
+ prettyPrint?: boolean;
1055
+ /** 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. */
1056
+ quotaUser?: string;
1057
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1058
+ upload_protocol?: string;
1059
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1060
+ uploadType?: string;
1061
+ }): Request<MigrationJob>;
1062
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
1063
+ getIamPolicy(request?: {
1064
+ /** V1 error format. */
1065
+ "$.xgafv"?: string;
1066
+ /** OAuth access token. */
1067
+ access_token?: string;
1068
+ /** Data format for response. */
1069
+ alt?: string;
1070
+ /** JSONP */
1071
+ callback?: string;
1072
+ /** Selector specifying which fields to include in a partial response. */
1073
+ fields?: string;
1074
+ /** 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. */
1075
+ key?: string;
1076
+ /** OAuth 2.0 token for the current user. */
1077
+ oauth_token?: string;
1078
+ /**
1079
+ * 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
1080
+ * 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
1081
+ * in 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
1082
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
1083
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1084
+ */
1085
+ "options.requestedPolicyVersion"?: number;
1086
+ /** Returns response with indentations and line breaks. */
1087
+ prettyPrint?: boolean;
1088
+ /** 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. */
1089
+ quotaUser?: string;
1090
+ /**
1091
+ * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
1092
+ * field.
1093
+ */
1094
+ resource: string;
1095
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1096
+ upload_protocol?: string;
1097
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1098
+ uploadType?: string;
1099
+ }): Request<Policy>;
1100
+ /** Lists migration jobs in a given project and location. */
1101
+ list(request?: {
1102
+ /** V1 error format. */
1103
+ "$.xgafv"?: string;
1104
+ /** OAuth access token. */
1105
+ access_token?: string;
1106
+ /** Data format for response. */
1107
+ alt?: string;
1108
+ /** JSONP */
1109
+ callback?: string;
1110
+ /** Selector specifying which fields to include in a partial response. */
1111
+ fields?: string;
1112
+ /**
1113
+ * A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for
1114
+ * filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by
1115
+ * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = "1.2.3.4"** to
1116
+ * select all migration jobs connecting through the specific SSH tunnel bastion.
1117
+ */
1118
+ filter?: string;
1119
+ /** 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. */
1120
+ key?: string;
1121
+ /** OAuth 2.0 token for the current user. */
1122
+ oauth_token?: string;
1123
+ /** Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc". */
1124
+ orderBy?: string;
1125
+ /**
1126
+ * The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is
1127
+ * 1000; values above 1000 will be coerced to 1000.
1128
+ */
1129
+ pageSize?: number;
1130
+ /**
1131
+ * The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be
1132
+ * left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.
1133
+ */
1134
+ pageToken?: string;
1135
+ /** Required. The parent, which owns this collection of migrationJobs. */
1136
+ parent: string;
1137
+ /** Returns response with indentations and line breaks. */
1138
+ prettyPrint?: boolean;
1139
+ /** 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. */
1140
+ quotaUser?: string;
1141
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1142
+ upload_protocol?: string;
1143
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1144
+ uploadType?: string;
1145
+ }): Request<ListMigrationJobsResponse>;
1146
+ /** Updates the parameters of a single migration job. */
1147
+ patch(request: {
1148
+ /** V1 error format. */
1149
+ "$.xgafv"?: string;
1150
+ /** OAuth access token. */
1151
+ access_token?: string;
1152
+ /** Data format for response. */
1153
+ alt?: string;
1154
+ /** JSONP */
1155
+ callback?: string;
1156
+ /** Selector specifying which fields to include in a partial response. */
1157
+ fields?: string;
1158
+ /** 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. */
1159
+ key?: string;
1160
+ /** The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. */
1161
+ name: string;
1162
+ /** OAuth 2.0 token for the current user. */
1163
+ oauth_token?: string;
1164
+ /** Returns response with indentations and line breaks. */
1165
+ prettyPrint?: boolean;
1166
+ /** 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. */
1167
+ quotaUser?: string;
1168
+ /**
1169
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
1170
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1171
+ */
1172
+ requestId?: string;
1173
+ /** Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update. */
1174
+ updateMask?: string;
1175
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1176
+ upload_protocol?: string;
1177
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1178
+ uploadType?: string;
1179
+ /** Request body */
1180
+ resource: MigrationJob;
1181
+ }): Request<Operation>;
1182
+ patch(request: {
1183
+ /** V1 error format. */
1184
+ "$.xgafv"?: string;
1185
+ /** OAuth access token. */
1186
+ access_token?: string;
1187
+ /** Data format for response. */
1188
+ alt?: string;
1189
+ /** JSONP */
1190
+ callback?: string;
1191
+ /** Selector specifying which fields to include in a partial response. */
1192
+ fields?: string;
1193
+ /** 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. */
1194
+ key?: string;
1195
+ /** The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. */
1196
+ name: string;
1197
+ /** OAuth 2.0 token for the current user. */
1198
+ oauth_token?: string;
1199
+ /** Returns response with indentations and line breaks. */
1200
+ prettyPrint?: boolean;
1201
+ /** 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. */
1202
+ quotaUser?: string;
1203
+ /**
1204
+ * A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this
1205
+ * value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1206
+ */
1207
+ requestId?: string;
1208
+ /** Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update. */
1209
+ updateMask?: string;
1210
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1211
+ upload_protocol?: string;
1212
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1213
+ uploadType?: string;
1214
+ },
1215
+ body: MigrationJob): Request<Operation>;
1216
+ /** Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database. */
1217
+ promote(request: {
1218
+ /** V1 error format. */
1219
+ "$.xgafv"?: string;
1220
+ /** OAuth access token. */
1221
+ access_token?: string;
1222
+ /** Data format for response. */
1223
+ alt?: string;
1224
+ /** JSONP */
1225
+ callback?: string;
1226
+ /** Selector specifying which fields to include in a partial response. */
1227
+ fields?: string;
1228
+ /** 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. */
1229
+ key?: string;
1230
+ /** Name of the migration job resource to promote. */
1231
+ name: string;
1232
+ /** OAuth 2.0 token for the current user. */
1233
+ oauth_token?: string;
1234
+ /** Returns response with indentations and line breaks. */
1235
+ prettyPrint?: boolean;
1236
+ /** 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. */
1237
+ quotaUser?: string;
1238
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1239
+ upload_protocol?: string;
1240
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1241
+ uploadType?: string;
1242
+ /** Request body */
1243
+ resource: PromoteMigrationJobRequest;
1244
+ }): Request<Operation>;
1245
+ promote(request: {
1246
+ /** V1 error format. */
1247
+ "$.xgafv"?: string;
1248
+ /** OAuth access token. */
1249
+ access_token?: string;
1250
+ /** Data format for response. */
1251
+ alt?: string;
1252
+ /** JSONP */
1253
+ callback?: string;
1254
+ /** Selector specifying which fields to include in a partial response. */
1255
+ fields?: string;
1256
+ /** 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. */
1257
+ key?: string;
1258
+ /** Name of the migration job resource to promote. */
1259
+ name: string;
1260
+ /** OAuth 2.0 token for the current user. */
1261
+ oauth_token?: string;
1262
+ /** Returns response with indentations and line breaks. */
1263
+ prettyPrint?: boolean;
1264
+ /** 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. */
1265
+ quotaUser?: string;
1266
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1267
+ upload_protocol?: string;
1268
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1269
+ uploadType?: string;
1270
+ },
1271
+ body: PromoteMigrationJobRequest): Request<Operation>;
1272
+ /** Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch. */
1273
+ restart(request: {
1274
+ /** V1 error format. */
1275
+ "$.xgafv"?: string;
1276
+ /** OAuth access token. */
1277
+ access_token?: string;
1278
+ /** Data format for response. */
1279
+ alt?: string;
1280
+ /** JSONP */
1281
+ callback?: string;
1282
+ /** Selector specifying which fields to include in a partial response. */
1283
+ fields?: string;
1284
+ /** 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. */
1285
+ key?: string;
1286
+ /** Name of the migration job resource to restart. */
1287
+ name: string;
1288
+ /** OAuth 2.0 token for the current user. */
1289
+ oauth_token?: string;
1290
+ /** Returns response with indentations and line breaks. */
1291
+ prettyPrint?: boolean;
1292
+ /** 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. */
1293
+ quotaUser?: string;
1294
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1295
+ upload_protocol?: string;
1296
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1297
+ uploadType?: string;
1298
+ /** Request body */
1299
+ resource: RestartMigrationJobRequest;
1300
+ }): Request<Operation>;
1301
+ restart(request: {
1302
+ /** V1 error format. */
1303
+ "$.xgafv"?: string;
1304
+ /** OAuth access token. */
1305
+ access_token?: string;
1306
+ /** Data format for response. */
1307
+ alt?: string;
1308
+ /** JSONP */
1309
+ callback?: string;
1310
+ /** Selector specifying which fields to include in a partial response. */
1311
+ fields?: string;
1312
+ /** 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. */
1313
+ key?: string;
1314
+ /** Name of the migration job resource to restart. */
1315
+ name: string;
1316
+ /** OAuth 2.0 token for the current user. */
1317
+ oauth_token?: string;
1318
+ /** Returns response with indentations and line breaks. */
1319
+ prettyPrint?: boolean;
1320
+ /** 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. */
1321
+ quotaUser?: string;
1322
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1323
+ upload_protocol?: string;
1324
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1325
+ uploadType?: string;
1326
+ },
1327
+ body: RestartMigrationJobRequest): Request<Operation>;
1328
+ /** Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase). */
1329
+ resume(request: {
1330
+ /** V1 error format. */
1331
+ "$.xgafv"?: string;
1332
+ /** OAuth access token. */
1333
+ access_token?: string;
1334
+ /** Data format for response. */
1335
+ alt?: string;
1336
+ /** JSONP */
1337
+ callback?: string;
1338
+ /** Selector specifying which fields to include in a partial response. */
1339
+ fields?: string;
1340
+ /** 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. */
1341
+ key?: string;
1342
+ /** Name of the migration job resource to resume. */
1343
+ name: string;
1344
+ /** OAuth 2.0 token for the current user. */
1345
+ oauth_token?: string;
1346
+ /** Returns response with indentations and line breaks. */
1347
+ prettyPrint?: boolean;
1348
+ /** 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. */
1349
+ quotaUser?: string;
1350
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1351
+ upload_protocol?: string;
1352
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1353
+ uploadType?: string;
1354
+ /** Request body */
1355
+ resource: ResumeMigrationJobRequest;
1356
+ }): Request<Operation>;
1357
+ resume(request: {
1358
+ /** V1 error format. */
1359
+ "$.xgafv"?: string;
1360
+ /** OAuth access token. */
1361
+ access_token?: string;
1362
+ /** Data format for response. */
1363
+ alt?: string;
1364
+ /** JSONP */
1365
+ callback?: string;
1366
+ /** Selector specifying which fields to include in a partial response. */
1367
+ fields?: string;
1368
+ /** 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. */
1369
+ key?: string;
1370
+ /** Name of the migration job resource to resume. */
1371
+ name: string;
1372
+ /** OAuth 2.0 token for the current user. */
1373
+ oauth_token?: string;
1374
+ /** Returns response with indentations and line breaks. */
1375
+ prettyPrint?: boolean;
1376
+ /** 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. */
1377
+ quotaUser?: string;
1378
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1379
+ upload_protocol?: string;
1380
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1381
+ uploadType?: string;
1382
+ },
1383
+ body: ResumeMigrationJobRequest): Request<Operation>;
1384
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
1385
+ setIamPolicy(request: {
1386
+ /** V1 error format. */
1387
+ "$.xgafv"?: string;
1388
+ /** OAuth access token. */
1389
+ access_token?: string;
1390
+ /** Data format for response. */
1391
+ alt?: string;
1392
+ /** JSONP */
1393
+ callback?: string;
1394
+ /** Selector specifying which fields to include in a partial response. */
1395
+ fields?: string;
1396
+ /** 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. */
1397
+ key?: string;
1398
+ /** OAuth 2.0 token for the current user. */
1399
+ oauth_token?: string;
1400
+ /** Returns response with indentations and line breaks. */
1401
+ prettyPrint?: boolean;
1402
+ /** 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. */
1403
+ quotaUser?: string;
1404
+ /**
1405
+ * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
1406
+ * field.
1407
+ */
1408
+ resource: string;
1409
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1410
+ upload_protocol?: string;
1411
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1412
+ uploadType?: string;
1413
+ },
1414
+ body: SetIamPolicyRequest): Request<Policy>;
1415
+ /** Start an already created migration job. */
1416
+ start(request: {
1417
+ /** V1 error format. */
1418
+ "$.xgafv"?: string;
1419
+ /** OAuth access token. */
1420
+ access_token?: string;
1421
+ /** Data format for response. */
1422
+ alt?: string;
1423
+ /** JSONP */
1424
+ callback?: string;
1425
+ /** Selector specifying which fields to include in a partial response. */
1426
+ fields?: string;
1427
+ /** 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. */
1428
+ key?: string;
1429
+ /** Name of the migration job resource to start. */
1430
+ name: string;
1431
+ /** OAuth 2.0 token for the current user. */
1432
+ oauth_token?: string;
1433
+ /** Returns response with indentations and line breaks. */
1434
+ prettyPrint?: boolean;
1435
+ /** 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. */
1436
+ quotaUser?: string;
1437
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1438
+ upload_protocol?: string;
1439
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1440
+ uploadType?: string;
1441
+ /** Request body */
1442
+ resource: StartMigrationJobRequest;
1443
+ }): Request<Operation>;
1444
+ start(request: {
1445
+ /** V1 error format. */
1446
+ "$.xgafv"?: string;
1447
+ /** OAuth access token. */
1448
+ access_token?: string;
1449
+ /** Data format for response. */
1450
+ alt?: string;
1451
+ /** JSONP */
1452
+ callback?: string;
1453
+ /** Selector specifying which fields to include in a partial response. */
1454
+ fields?: string;
1455
+ /** 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. */
1456
+ key?: string;
1457
+ /** Name of the migration job resource to start. */
1458
+ name: string;
1459
+ /** OAuth 2.0 token for the current user. */
1460
+ oauth_token?: string;
1461
+ /** Returns response with indentations and line breaks. */
1462
+ prettyPrint?: boolean;
1463
+ /** 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. */
1464
+ quotaUser?: string;
1465
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1466
+ upload_protocol?: string;
1467
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1468
+ uploadType?: string;
1469
+ },
1470
+ body: StartMigrationJobRequest): Request<Operation>;
1471
+ /** Stops a running migration job. */
1472
+ stop(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
+ /** Name of the migration job resource to stop. */
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 body */
1498
+ resource: StopMigrationJobRequest;
1499
+ }): Request<Operation>;
1500
+ stop(request: {
1501
+ /** V1 error format. */
1502
+ "$.xgafv"?: string;
1503
+ /** OAuth access token. */
1504
+ access_token?: string;
1505
+ /** Data format for response. */
1506
+ alt?: string;
1507
+ /** JSONP */
1508
+ callback?: string;
1509
+ /** Selector specifying which fields to include in a partial response. */
1510
+ fields?: string;
1511
+ /** 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. */
1512
+ key?: string;
1513
+ /** Name of the migration job resource to stop. */
1514
+ name: string;
1515
+ /** OAuth 2.0 token for the current user. */
1516
+ oauth_token?: string;
1517
+ /** Returns response with indentations and line breaks. */
1518
+ prettyPrint?: boolean;
1519
+ /** 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. */
1520
+ quotaUser?: string;
1521
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1522
+ upload_protocol?: string;
1523
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1524
+ uploadType?: string;
1525
+ },
1526
+ body: StopMigrationJobRequest): Request<Operation>;
1527
+ /**
1528
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
1529
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1530
+ */
1531
+ testIamPermissions(request: {
1532
+ /** V1 error format. */
1533
+ "$.xgafv"?: string;
1534
+ /** OAuth access token. */
1535
+ access_token?: string;
1536
+ /** Data format for response. */
1537
+ alt?: string;
1538
+ /** JSONP */
1539
+ callback?: string;
1540
+ /** Selector specifying which fields to include in a partial response. */
1541
+ fields?: string;
1542
+ /** 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. */
1543
+ key?: string;
1544
+ /** OAuth 2.0 token for the current user. */
1545
+ oauth_token?: string;
1546
+ /** Returns response with indentations and line breaks. */
1547
+ prettyPrint?: boolean;
1548
+ /** 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. */
1549
+ quotaUser?: string;
1550
+ /**
1551
+ * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
1552
+ * this field.
1553
+ */
1554
+ resource: string;
1555
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1556
+ upload_protocol?: string;
1557
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1558
+ uploadType?: string;
1559
+ },
1560
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1561
+ /** Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met. */
1562
+ verify(request: {
1563
+ /** V1 error format. */
1564
+ "$.xgafv"?: string;
1565
+ /** OAuth access token. */
1566
+ access_token?: string;
1567
+ /** Data format for response. */
1568
+ alt?: string;
1569
+ /** JSONP */
1570
+ callback?: string;
1571
+ /** Selector specifying which fields to include in a partial response. */
1572
+ fields?: string;
1573
+ /** 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. */
1574
+ key?: string;
1575
+ /** Name of the migration job resource to verify. */
1576
+ name: string;
1577
+ /** OAuth 2.0 token for the current user. */
1578
+ oauth_token?: string;
1579
+ /** Returns response with indentations and line breaks. */
1580
+ prettyPrint?: boolean;
1581
+ /** 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. */
1582
+ quotaUser?: string;
1583
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1584
+ upload_protocol?: string;
1585
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1586
+ uploadType?: string;
1587
+ /** Request body */
1588
+ resource: VerifyMigrationJobRequest;
1589
+ }): Request<Operation>;
1590
+ verify(request: {
1591
+ /** V1 error format. */
1592
+ "$.xgafv"?: string;
1593
+ /** OAuth access token. */
1594
+ access_token?: string;
1595
+ /** Data format for response. */
1596
+ alt?: string;
1597
+ /** JSONP */
1598
+ callback?: string;
1599
+ /** Selector specifying which fields to include in a partial response. */
1600
+ fields?: string;
1601
+ /** 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. */
1602
+ key?: string;
1603
+ /** Name of the migration job resource to verify. */
1604
+ name: string;
1605
+ /** OAuth 2.0 token for the current user. */
1606
+ oauth_token?: string;
1607
+ /** Returns response with indentations and line breaks. */
1608
+ prettyPrint?: boolean;
1609
+ /** 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. */
1610
+ quotaUser?: string;
1611
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1612
+ upload_protocol?: string;
1613
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1614
+ uploadType?: string;
1615
+ },
1616
+ body: VerifyMigrationJobRequest): Request<Operation>;
1617
+ }
1618
+ interface OperationsResource {
1619
+ /**
1620
+ * 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
1621
+ * 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
1622
+ * operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
1623
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1624
+ */
1625
+ cancel(request: {
1626
+ /** V1 error format. */
1627
+ "$.xgafv"?: string;
1628
+ /** OAuth access token. */
1629
+ access_token?: string;
1630
+ /** Data format for response. */
1631
+ alt?: string;
1632
+ /** JSONP */
1633
+ callback?: string;
1634
+ /** Selector specifying which fields to include in a partial response. */
1635
+ fields?: string;
1636
+ /** 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. */
1637
+ key?: string;
1638
+ /** The name of the operation resource to be cancelled. */
1639
+ name: string;
1640
+ /** OAuth 2.0 token for the current user. */
1641
+ oauth_token?: string;
1642
+ /** Returns response with indentations and line breaks. */
1643
+ prettyPrint?: boolean;
1644
+ /** 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. */
1645
+ quotaUser?: string;
1646
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1647
+ upload_protocol?: string;
1648
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1649
+ uploadType?: string;
1650
+ /** Request body */
1651
+ resource: CancelOperationRequest;
1652
+ }): Request<{}>;
1653
+ cancel(request: {
1654
+ /** V1 error format. */
1655
+ "$.xgafv"?: string;
1656
+ /** OAuth access token. */
1657
+ access_token?: string;
1658
+ /** Data format for response. */
1659
+ alt?: string;
1660
+ /** JSONP */
1661
+ callback?: string;
1662
+ /** Selector specifying which fields to include in a partial response. */
1663
+ fields?: string;
1664
+ /** 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. */
1665
+ key?: string;
1666
+ /** The name of the operation resource to be cancelled. */
1667
+ name: string;
1668
+ /** OAuth 2.0 token for the current user. */
1669
+ oauth_token?: string;
1670
+ /** Returns response with indentations and line breaks. */
1671
+ prettyPrint?: boolean;
1672
+ /** 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. */
1673
+ quotaUser?: string;
1674
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1675
+ upload_protocol?: string;
1676
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1677
+ uploadType?: string;
1678
+ },
1679
+ body: CancelOperationRequest): Request<{}>;
1680
+ /**
1681
+ * 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
1682
+ * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1683
+ */
1684
+ delete(request?: {
1685
+ /** V1 error format. */
1686
+ "$.xgafv"?: string;
1687
+ /** OAuth access token. */
1688
+ access_token?: string;
1689
+ /** Data format for response. */
1690
+ alt?: string;
1691
+ /** JSONP */
1692
+ callback?: string;
1693
+ /** Selector specifying which fields to include in a partial response. */
1694
+ fields?: string;
1695
+ /** 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. */
1696
+ key?: string;
1697
+ /** The name of the operation resource to be deleted. */
1698
+ name: string;
1699
+ /** OAuth 2.0 token for the current user. */
1700
+ oauth_token?: string;
1701
+ /** Returns response with indentations and line breaks. */
1702
+ prettyPrint?: boolean;
1703
+ /** 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. */
1704
+ quotaUser?: string;
1705
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1706
+ upload_protocol?: string;
1707
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1708
+ uploadType?: string;
1709
+ }): Request<{}>;
1710
+ /** 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. */
1711
+ get(request?: {
1712
+ /** V1 error format. */
1713
+ "$.xgafv"?: string;
1714
+ /** OAuth access token. */
1715
+ access_token?: string;
1716
+ /** Data format for response. */
1717
+ alt?: string;
1718
+ /** JSONP */
1719
+ callback?: string;
1720
+ /** Selector specifying which fields to include in a partial response. */
1721
+ fields?: string;
1722
+ /** 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. */
1723
+ key?: string;
1724
+ /** The name of the operation resource. */
1725
+ name: string;
1726
+ /** OAuth 2.0 token for the current user. */
1727
+ oauth_token?: string;
1728
+ /** Returns response with indentations and line breaks. */
1729
+ prettyPrint?: boolean;
1730
+ /** 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. */
1731
+ quotaUser?: string;
1732
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1733
+ upload_protocol?: string;
1734
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1735
+ uploadType?: string;
1736
+ }): Request<Operation>;
1737
+ /**
1738
+ * 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
1739
+ * 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
1740
+ * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
1741
+ * ensure the name binding is the parent resource, without the operations collection id.
1742
+ */
1743
+ list(request?: {
1744
+ /** V1 error format. */
1745
+ "$.xgafv"?: string;
1746
+ /** OAuth access token. */
1747
+ access_token?: string;
1748
+ /** Data format for response. */
1749
+ alt?: string;
1750
+ /** JSONP */
1751
+ callback?: string;
1752
+ /** Selector specifying which fields to include in a partial response. */
1753
+ fields?: string;
1754
+ /** The standard list filter. */
1755
+ filter?: string;
1756
+ /** 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. */
1757
+ key?: string;
1758
+ /** The name of the operation's parent resource. */
1759
+ name: string;
1760
+ /** OAuth 2.0 token for the current user. */
1761
+ oauth_token?: string;
1762
+ /** The standard list page size. */
1763
+ pageSize?: number;
1764
+ /** The standard list page token. */
1765
+ pageToken?: string;
1766
+ /** Returns response with indentations and line breaks. */
1767
+ prettyPrint?: boolean;
1768
+ /** 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. */
1769
+ quotaUser?: string;
1770
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1771
+ upload_protocol?: string;
1772
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1773
+ uploadType?: string;
1774
+ }): Request<ListOperationsResponse>;
1775
+ }
1776
+ interface LocationsResource {
1777
+ /** Gets information about a location. */
1778
+ get(request?: {
1779
+ /** V1 error format. */
1780
+ "$.xgafv"?: string;
1781
+ /** OAuth access token. */
1782
+ access_token?: string;
1783
+ /** Data format for response. */
1784
+ alt?: string;
1785
+ /** JSONP */
1786
+ callback?: string;
1787
+ /** Selector specifying which fields to include in a partial response. */
1788
+ fields?: string;
1789
+ /** 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. */
1790
+ key?: string;
1791
+ /** Resource name for the location. */
1792
+ name: string;
1793
+ /** OAuth 2.0 token for the current user. */
1794
+ oauth_token?: string;
1795
+ /** Returns response with indentations and line breaks. */
1796
+ prettyPrint?: boolean;
1797
+ /** 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. */
1798
+ quotaUser?: string;
1799
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1800
+ upload_protocol?: string;
1801
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1802
+ uploadType?: string;
1803
+ }): Request<Location>;
1804
+ /** Lists information about the supported locations for this service. */
1805
+ list(request?: {
1806
+ /** V1 error format. */
1807
+ "$.xgafv"?: string;
1808
+ /** OAuth access token. */
1809
+ access_token?: string;
1810
+ /** Data format for response. */
1811
+ alt?: string;
1812
+ /** JSONP */
1813
+ callback?: string;
1814
+ /** Selector specifying which fields to include in a partial response. */
1815
+ fields?: string;
1816
+ /**
1817
+ * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
1818
+ * [AIP-160](https://google.aip.dev/160).
1819
+ */
1820
+ filter?: string;
1821
+ /** 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. */
1822
+ key?: string;
1823
+ /** The resource that owns the locations collection, if applicable. */
1824
+ name: string;
1825
+ /** OAuth 2.0 token for the current user. */
1826
+ oauth_token?: string;
1827
+ /** The maximum number of results to return. If not set, the service selects a default. */
1828
+ pageSize?: number;
1829
+ /** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
1830
+ pageToken?: string;
1831
+ /** Returns response with indentations and line breaks. */
1832
+ prettyPrint?: boolean;
1833
+ /** 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. */
1834
+ quotaUser?: string;
1835
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1836
+ upload_protocol?: string;
1837
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1838
+ uploadType?: string;
1839
+ }): Request<ListLocationsResponse>;
1840
+ connectionProfiles: ConnectionProfilesResource;
1841
+ migrationJobs: MigrationJobsResource;
1842
+ operations: OperationsResource;
1843
+ }
1844
+ interface ProjectsResource {
1845
+ locations: LocationsResource;
1846
+ }
1847
+
1848
+ const projects: ProjectsResource;
1849
+ }
1850
+ }