@google-cloud/dms 2.2.2 → 3.0.0

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.
@@ -1,6 +1,6 @@
1
1
  /// <reference types="node" />
2
2
  import type * as gax from 'google-gax';
3
- import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax';
4
4
  import { Transform } from 'stream';
5
5
  import * as protos from '../../protos/protos';
6
6
  /**
@@ -22,6 +22,8 @@ export declare class DataMigrationServiceClient {
22
22
  innerApiCalls: {
23
23
  [name: string]: Function;
24
24
  };
25
+ iamClient: IamClient;
26
+ locationsClient: LocationsClient;
25
27
  pathTemplates: {
26
28
  [name: string]: gax.PathTemplate;
27
29
  };
@@ -118,9 +120,8 @@ export declare class DataMigrationServiceClient {
118
120
  * @param {object} [options]
119
121
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
120
122
  * @returns {Promise} - The promise which resolves to an array.
121
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}.
122
- * Please see the
123
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
123
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}.
124
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
124
125
  * for more details and examples.
125
126
  * @example <caption>include:samples/generated/v1/data_migration_service.get_migration_job.js</caption>
126
127
  * region_tag:datamigration_v1_generated_DataMigrationService_GetMigrationJob_async
@@ -147,13 +148,12 @@ export declare class DataMigrationServiceClient {
147
148
  * @param {google.cloud.clouddms.v1.VmSelectionConfig} request.vmSelectionConfig
148
149
  * The VM selection configuration
149
150
  * @param {number} request.vmPort
150
- * The port that will be open on the bastion host
151
+ * The port that will be open on the bastion host.
151
152
  * @param {object} [options]
152
153
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
153
154
  * @returns {Promise} - The promise which resolves to an array.
154
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.SshScript | SshScript}.
155
- * Please see the
156
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
155
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SshScript|SshScript}.
156
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
157
157
  * for more details and examples.
158
158
  * @example <caption>include:samples/generated/v1/data_migration_service.generate_ssh_script.js</caption>
159
159
  * region_tag:datamigration_v1_generated_DataMigrationService_GenerateSshScript_async
@@ -175,9 +175,8 @@ export declare class DataMigrationServiceClient {
175
175
  * @param {object} [options]
176
176
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
177
177
  * @returns {Promise} - The promise which resolves to an array.
178
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}.
179
- * Please see the
180
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
178
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}.
179
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
181
180
  * for more details and examples.
182
181
  * @example <caption>include:samples/generated/v1/data_migration_service.get_connection_profile.js</caption>
183
182
  * region_tag:datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async
@@ -189,13 +188,127 @@ export declare class DataMigrationServiceClient {
189
188
  ]>;
190
189
  getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
191
190
  getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
191
+ /**
192
+ * Gets details of a single private connection.
193
+ *
194
+ * @param {Object} request
195
+ * The request object that will be sent.
196
+ * @param {string} request.name
197
+ * Required. The name of the private connection to get.
198
+ * @param {object} [options]
199
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
200
+ * @returns {Promise} - The promise which resolves to an array.
201
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}.
202
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
203
+ * for more details and examples.
204
+ * @example <caption>include:samples/generated/v1/data_migration_service.get_private_connection.js</caption>
205
+ * region_tag:datamigration_v1_generated_DataMigrationService_GetPrivateConnection_async
206
+ */
207
+ getPrivateConnection(request?: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, options?: CallOptions): Promise<[
208
+ protos.google.cloud.clouddms.v1.IPrivateConnection,
209
+ protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | undefined,
210
+ {} | undefined
211
+ ]>;
212
+ getPrivateConnection(request: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
213
+ getPrivateConnection(request: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, callback: Callback<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
214
+ /**
215
+ * Gets details of a single conversion workspace.
216
+ *
217
+ * @param {Object} request
218
+ * The request object that will be sent.
219
+ * @param {string} request.name
220
+ * Required. Name of the conversion workspace resource to get.
221
+ * @param {object} [options]
222
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
223
+ * @returns {Promise} - The promise which resolves to an array.
224
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}.
225
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
226
+ * for more details and examples.
227
+ * @example <caption>include:samples/generated/v1/data_migration_service.get_conversion_workspace.js</caption>
228
+ * region_tag:datamigration_v1_generated_DataMigrationService_GetConversionWorkspace_async
229
+ */
230
+ getConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, options?: CallOptions): Promise<[
231
+ protos.google.cloud.clouddms.v1.IConversionWorkspace,
232
+ (protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | undefined),
233
+ {} | undefined
234
+ ]>;
235
+ getConversionWorkspace(request: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | null | undefined, {} | null | undefined>): void;
236
+ getConversionWorkspace(request: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, callback: Callback<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | null | undefined, {} | null | undefined>): void;
237
+ /**
238
+ * Searches/lists the background jobs for a specific
239
+ * conversion workspace.
240
+ *
241
+ * The background jobs are not resources like conversion workspaces or
242
+ * mapping rules, and they can't be created, updated or deleted.
243
+ * Instead, they are a way to expose the data plane jobs log.
244
+ *
245
+ * @param {Object} request
246
+ * The request object that will be sent.
247
+ * @param {string} request.conversionWorkspace
248
+ * Required. Name of the conversion workspace resource whose jobs are listed,
249
+ * in the form of:
250
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
251
+ * @param {boolean} [request.returnMostRecentPerJobType]
252
+ * Optional. Whether or not to return just the most recent job per job type,
253
+ * @param {number} [request.maxSize]
254
+ * Optional. The maximum number of jobs to return. The service may return
255
+ * fewer than this value. If unspecified, at most 100 jobs are
256
+ * returned. The maximum value is 100; values above 100 are coerced to
257
+ * 100.
258
+ * @param {google.protobuf.Timestamp} [request.completedUntilTime]
259
+ * Optional. If provided, only returns jobs that completed until (not
260
+ * including) the given timestamp.
261
+ * @param {object} [options]
262
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
263
+ * @returns {Promise} - The promise which resolves to an array.
264
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SearchBackgroundJobsResponse|SearchBackgroundJobsResponse}.
265
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
266
+ * for more details and examples.
267
+ * @example <caption>include:samples/generated/v1/data_migration_service.search_background_jobs.js</caption>
268
+ * region_tag:datamigration_v1_generated_DataMigrationService_SearchBackgroundJobs_async
269
+ */
270
+ searchBackgroundJobs(request?: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, options?: CallOptions): Promise<[
271
+ protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse,
272
+ protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | undefined,
273
+ {} | undefined
274
+ ]>;
275
+ searchBackgroundJobs(request: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse, protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | null | undefined, {} | null | undefined>): void;
276
+ searchBackgroundJobs(request: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, callback: Callback<protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse, protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | null | undefined, {} | null | undefined>): void;
277
+ /**
278
+ * Retrieves a list of committed revisions of a specific conversion
279
+ * workspace.
280
+ *
281
+ * @param {Object} request
282
+ * The request object that will be sent.
283
+ * @param {string} request.conversionWorkspace
284
+ * Required. Name of the conversion workspace resource whose revisions are
285
+ * listed. Must be in the form of:
286
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
287
+ * @param {string} [request.commitId]
288
+ * Optional. Optional filter to request a specific commit ID.
289
+ * @param {object} [options]
290
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
291
+ * @returns {Promise} - The promise which resolves to an array.
292
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse|DescribeConversionWorkspaceRevisionsResponse}.
293
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
294
+ * for more details and examples.
295
+ * @example <caption>include:samples/generated/v1/data_migration_service.describe_conversion_workspace_revisions.js</caption>
296
+ * region_tag:datamigration_v1_generated_DataMigrationService_DescribeConversionWorkspaceRevisions_async
297
+ */
298
+ describeConversionWorkspaceRevisions(request?: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, options?: CallOptions): Promise<[
299
+ protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse,
300
+ (protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | undefined),
301
+ {} | undefined
302
+ ]>;
303
+ describeConversionWorkspaceRevisions(request: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse, protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | null | undefined, {} | null | undefined>): void;
304
+ describeConversionWorkspaceRevisions(request: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, callback: Callback<protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse, protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | null | undefined, {} | null | undefined>): void;
192
305
  /**
193
306
  * Creates a new migration job in a given project and location.
194
307
  *
195
308
  * @param {Object} request
196
309
  * The request object that will be sent.
197
310
  * @param {string} request.parent
198
- * Required. The parent, which owns this collection of migration jobs.
311
+ * Required. The parent which owns this collection of migration jobs.
199
312
  * @param {string} request.migrationJobId
200
313
  * Required. The ID of the instance to create.
201
314
  * @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
@@ -203,12 +316,12 @@ export declare class DataMigrationServiceClient {
203
316
  * job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
204
317
  * object.
205
318
  * @param {string} request.requestId
206
- * A unique id used to identify the request. If the server receives two
207
- * requests with the same id, then the second request will be ignored.
319
+ * A unique ID used to identify the request. If the server receives two
320
+ * requests with the same ID, then the second request is ignored.
208
321
  *
209
322
  * It is recommended to always set this value to a UUID.
210
323
  *
211
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
324
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
212
325
  * (_), and hyphens (-). The maximum length is 40 characters.
213
326
  * @param {object} [options]
214
327
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
@@ -216,8 +329,7 @@ export declare class DataMigrationServiceClient {
216
329
  * The first element of the array is an object representing
217
330
  * a long running operation. Its `promise()` method returns a promise
218
331
  * you can `await` for.
219
- * Please see the
220
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
332
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
221
333
  * for more details and examples.
222
334
  * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
223
335
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
@@ -235,8 +347,7 @@ export declare class DataMigrationServiceClient {
235
347
  * The operation name that will be passed.
236
348
  * @returns {Promise} - The promise which resolves to an object.
237
349
  * The decoded operation object has result and metadata field to get information from.
238
- * Please see the
239
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
350
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
240
351
  * for more details and examples.
241
352
  * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
242
353
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
@@ -248,17 +359,17 @@ export declare class DataMigrationServiceClient {
248
359
  * @param {Object} request
249
360
  * The request object that will be sent.
250
361
  * @param {google.protobuf.FieldMask} request.updateMask
251
- * Required. Field mask is used to specify the fields to be overwritten in the
252
- * migration job resource by the update.
362
+ * Required. Field mask is used to specify the fields to be overwritten by the
363
+ * update in the conversion workspace resource.
253
364
  * @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
254
365
  * Required. The migration job parameters to update.
255
366
  * @param {string} request.requestId
256
- * A unique id used to identify the request. If the server receives two
257
- * requests with the same id, then the second request will be ignored.
367
+ * A unique ID used to identify the request. If the server receives two
368
+ * requests with the same ID, then the second request is ignored.
258
369
  *
259
370
  * It is recommended to always set this value to a UUID.
260
371
  *
261
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
372
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
262
373
  * (_), and hyphens (-). The maximum length is 40 characters.
263
374
  * @param {object} [options]
264
375
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
@@ -266,8 +377,7 @@ export declare class DataMigrationServiceClient {
266
377
  * The first element of the array is an object representing
267
378
  * a long running operation. Its `promise()` method returns a promise
268
379
  * you can `await` for.
269
- * Please see the
270
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
380
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
271
381
  * for more details and examples.
272
382
  * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
273
383
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
@@ -285,8 +395,7 @@ export declare class DataMigrationServiceClient {
285
395
  * The operation name that will be passed.
286
396
  * @returns {Promise} - The promise which resolves to an object.
287
397
  * The decoded operation object has result and metadata field to get information from.
288
- * Please see the
289
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
398
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
290
399
  * for more details and examples.
291
400
  * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
292
401
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
@@ -300,12 +409,12 @@ export declare class DataMigrationServiceClient {
300
409
  * @param {string} request.name
301
410
  * Required. Name of the migration job resource to delete.
302
411
  * @param {string} request.requestId
303
- * A unique id used to identify the request. If the server receives two
304
- * requests with the same id, then the second request will be ignored.
412
+ * A unique ID used to identify the request. If the server receives two
413
+ * requests with the same ID, then the second request is ignored.
305
414
  *
306
415
  * It is recommended to always set this value to a UUID.
307
416
  *
308
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
417
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
309
418
  * (_), and hyphens (-). The maximum length is 40 characters.
310
419
  * @param {boolean} request.force
311
420
  * The destination CloudSQL connection profile is always deleted with the
@@ -317,8 +426,7 @@ export declare class DataMigrationServiceClient {
317
426
  * The first element of the array is an object representing
318
427
  * a long running operation. Its `promise()` method returns a promise
319
428
  * you can `await` for.
320
- * Please see the
321
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
429
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
322
430
  * for more details and examples.
323
431
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
324
432
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
@@ -336,8 +444,7 @@ export declare class DataMigrationServiceClient {
336
444
  * The operation name that will be passed.
337
445
  * @returns {Promise} - The promise which resolves to an object.
338
446
  * The decoded operation object has result and metadata field to get information from.
339
- * Please see the
340
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
447
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
341
448
  * for more details and examples.
342
449
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
343
450
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
@@ -356,8 +463,7 @@ export declare class DataMigrationServiceClient {
356
463
  * The first element of the array is an object representing
357
464
  * a long running operation. Its `promise()` method returns a promise
358
465
  * you can `await` for.
359
- * Please see the
360
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
466
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
361
467
  * for more details and examples.
362
468
  * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
363
469
  * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
@@ -375,8 +481,7 @@ export declare class DataMigrationServiceClient {
375
481
  * The operation name that will be passed.
376
482
  * @returns {Promise} - The promise which resolves to an object.
377
483
  * The decoded operation object has result and metadata field to get information from.
378
- * Please see the
379
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
484
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
380
485
  * for more details and examples.
381
486
  * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
382
487
  * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
@@ -395,8 +500,7 @@ export declare class DataMigrationServiceClient {
395
500
  * The first element of the array is an object representing
396
501
  * a long running operation. Its `promise()` method returns a promise
397
502
  * you can `await` for.
398
- * Please see the
399
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
503
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
400
504
  * for more details and examples.
401
505
  * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
402
506
  * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
@@ -414,8 +518,7 @@ export declare class DataMigrationServiceClient {
414
518
  * The operation name that will be passed.
415
519
  * @returns {Promise} - The promise which resolves to an object.
416
520
  * The decoded operation object has result and metadata field to get information from.
417
- * Please see the
418
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
521
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
419
522
  * for more details and examples.
420
523
  * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
421
524
  * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
@@ -435,8 +538,7 @@ export declare class DataMigrationServiceClient {
435
538
  * The first element of the array is an object representing
436
539
  * a long running operation. Its `promise()` method returns a promise
437
540
  * you can `await` for.
438
- * Please see the
439
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
541
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
440
542
  * for more details and examples.
441
543
  * @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
442
544
  * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
@@ -454,8 +556,7 @@ export declare class DataMigrationServiceClient {
454
556
  * The operation name that will be passed.
455
557
  * @returns {Promise} - The promise which resolves to an object.
456
558
  * The decoded operation object has result and metadata field to get information from.
457
- * Please see the
458
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
559
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
459
560
  * for more details and examples.
460
561
  * @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
461
562
  * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
@@ -475,8 +576,7 @@ export declare class DataMigrationServiceClient {
475
576
  * The first element of the array is an object representing
476
577
  * a long running operation. Its `promise()` method returns a promise
477
578
  * you can `await` for.
478
- * Please see the
479
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
579
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
480
580
  * for more details and examples.
481
581
  * @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
482
582
  * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
@@ -494,8 +594,7 @@ export declare class DataMigrationServiceClient {
494
594
  * The operation name that will be passed.
495
595
  * @returns {Promise} - The promise which resolves to an object.
496
596
  * The decoded operation object has result and metadata field to get information from.
497
- * Please see the
498
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
597
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
499
598
  * for more details and examples.
500
599
  * @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
501
600
  * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
@@ -515,8 +614,7 @@ export declare class DataMigrationServiceClient {
515
614
  * The first element of the array is an object representing
516
615
  * a long running operation. Its `promise()` method returns a promise
517
616
  * you can `await` for.
518
- * Please see the
519
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
617
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
520
618
  * for more details and examples.
521
619
  * @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
522
620
  * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
@@ -534,8 +632,7 @@ export declare class DataMigrationServiceClient {
534
632
  * The operation name that will be passed.
535
633
  * @returns {Promise} - The promise which resolves to an object.
536
634
  * The decoded operation object has result and metadata field to get information from.
537
- * Please see the
538
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
635
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
539
636
  * for more details and examples.
540
637
  * @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
541
638
  * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
@@ -556,8 +653,7 @@ export declare class DataMigrationServiceClient {
556
653
  * The first element of the array is an object representing
557
654
  * a long running operation. Its `promise()` method returns a promise
558
655
  * you can `await` for.
559
- * Please see the
560
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
656
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
561
657
  * for more details and examples.
562
658
  * @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
563
659
  * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
@@ -575,8 +671,7 @@ export declare class DataMigrationServiceClient {
575
671
  * The operation name that will be passed.
576
672
  * @returns {Promise} - The promise which resolves to an object.
577
673
  * The decoded operation object has result and metadata field to get information from.
578
- * Please see the
579
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
674
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
580
675
  * for more details and examples.
581
676
  * @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
582
677
  * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
@@ -588,27 +683,34 @@ export declare class DataMigrationServiceClient {
588
683
  * @param {Object} request
589
684
  * The request object that will be sent.
590
685
  * @param {string} request.parent
591
- * Required. The parent, which owns this collection of connection profiles.
686
+ * Required. The parent which owns this collection of connection profiles.
592
687
  * @param {string} request.connectionProfileId
593
688
  * Required. The connection profile identifier.
594
689
  * @param {google.cloud.clouddms.v1.ConnectionProfile} request.connectionProfile
595
690
  * Required. The create request body including the connection profile data
596
- * @param {string} request.requestId
597
- * A unique id used to identify the request. If the server receives two
598
- * requests with the same id, then the second request will be ignored.
691
+ * @param {string} [request.requestId]
692
+ * Optional. A unique ID used to identify the request. If the server receives
693
+ * two requests with the same ID, then the second request is ignored.
599
694
  *
600
695
  * It is recommended to always set this value to a UUID.
601
696
  *
602
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
697
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
603
698
  * (_), and hyphens (-). The maximum length is 40 characters.
699
+ * @param {boolean} [request.validateOnly]
700
+ * Optional. Only validate the connection profile, but don't create any
701
+ * resources. The default is false. Only supported for Oracle connection
702
+ * profiles.
703
+ * @param {boolean} [request.skipValidation]
704
+ * Optional. Create the connection profile without validating it.
705
+ * The default is false.
706
+ * Only supported for Oracle connection profiles.
604
707
  * @param {object} [options]
605
708
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
606
709
  * @returns {Promise} - The promise which resolves to an array.
607
710
  * The first element of the array is an object representing
608
711
  * a long running operation. Its `promise()` method returns a promise
609
712
  * you can `await` for.
610
- * Please see the
611
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
713
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
612
714
  * for more details and examples.
613
715
  * @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
614
716
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
@@ -626,8 +728,7 @@ export declare class DataMigrationServiceClient {
626
728
  * The operation name that will be passed.
627
729
  * @returns {Promise} - The promise which resolves to an object.
628
730
  * The decoded operation object has result and metadata field to get information from.
629
- * Please see the
630
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
731
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
631
732
  * for more details and examples.
632
733
  * @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
633
734
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
@@ -639,26 +740,33 @@ export declare class DataMigrationServiceClient {
639
740
  * @param {Object} request
640
741
  * The request object that will be sent.
641
742
  * @param {google.protobuf.FieldMask} request.updateMask
642
- * Required. Field mask is used to specify the fields to be overwritten in the
643
- * connection profile resource by the update.
743
+ * Required. Field mask is used to specify the fields to be overwritten by the
744
+ * update in the conversion workspace resource.
644
745
  * @param {google.cloud.clouddms.v1.ConnectionProfile} request.connectionProfile
645
746
  * Required. The connection profile parameters to update.
646
- * @param {string} request.requestId
647
- * A unique id used to identify the request. If the server receives two
648
- * requests with the same id, then the second request will be ignored.
747
+ * @param {string} [request.requestId]
748
+ * Optional. A unique ID used to identify the request. If the server receives
749
+ * two requests with the same ID, then the second request is ignored.
649
750
  *
650
751
  * It is recommended to always set this value to a UUID.
651
752
  *
652
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
753
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
653
754
  * (_), and hyphens (-). The maximum length is 40 characters.
755
+ * @param {boolean} [request.validateOnly]
756
+ * Optional. Only validate the connection profile, but don't update any
757
+ * resources. The default is false. Only supported for Oracle connection
758
+ * profiles.
759
+ * @param {boolean} [request.skipValidation]
760
+ * Optional. Update the connection profile without validating it.
761
+ * The default is false.
762
+ * Only supported for Oracle connection profiles.
654
763
  * @param {object} [options]
655
764
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
656
765
  * @returns {Promise} - The promise which resolves to an array.
657
766
  * The first element of the array is an object representing
658
767
  * a long running operation. Its `promise()` method returns a promise
659
768
  * you can `await` for.
660
- * Please see the
661
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
769
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
662
770
  * for more details and examples.
663
771
  * @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
664
772
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
@@ -676,8 +784,7 @@ export declare class DataMigrationServiceClient {
676
784
  * The operation name that will be passed.
677
785
  * @returns {Promise} - The promise which resolves to an object.
678
786
  * The decoded operation object has result and metadata field to get information from.
679
- * Please see the
680
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
787
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
681
788
  * for more details and examples.
682
789
  * @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
683
790
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
@@ -693,12 +800,12 @@ export declare class DataMigrationServiceClient {
693
800
  * @param {string} request.name
694
801
  * Required. Name of the connection profile resource to delete.
695
802
  * @param {string} request.requestId
696
- * A unique id used to identify the request. If the server receives two
697
- * requests with the same id, then the second request will be ignored.
803
+ * A unique ID used to identify the request. If the server receives two
804
+ * requests with the same ID, then the second request is ignored.
698
805
  *
699
806
  * It is recommended to always set this value to a UUID.
700
807
  *
701
- * The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
808
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
702
809
  * (_), and hyphens (-). The maximum length is 40 characters.
703
810
  * @param {boolean} request.force
704
811
  * In case of force delete, the CloudSQL replica database is also deleted
@@ -709,8 +816,7 @@ export declare class DataMigrationServiceClient {
709
816
  * The first element of the array is an object representing
710
817
  * a long running operation. Its `promise()` method returns a promise
711
818
  * you can `await` for.
712
- * Please see the
713
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
819
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
714
820
  * for more details and examples.
715
821
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
716
822
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
@@ -728,290 +834,1502 @@ export declare class DataMigrationServiceClient {
728
834
  * The operation name that will be passed.
729
835
  * @returns {Promise} - The promise which resolves to an object.
730
836
  * The decoded operation object has result and metadata field to get information from.
731
- * Please see the
732
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
837
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
733
838
  * for more details and examples.
734
839
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
735
840
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
736
841
  */
737
842
  checkDeleteConnectionProfileProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
738
843
  /**
739
- * Lists migration jobs in a given project and location.
844
+ * Creates a new private connection in a given project and location.
740
845
  *
741
846
  * @param {Object} request
742
847
  * The request object that will be sent.
743
848
  * @param {string} request.parent
744
- * Required. The parent, which owns this collection of migrationJobs.
745
- * @param {number} request.pageSize
746
- * The maximum number of migration jobs to return. The service may return
747
- * fewer than this value. If unspecified, at most 50 migration jobs will be
748
- * returned. The maximum value is 1000; values above 1000 will be coerced to
749
- * 1000.
750
- * @param {string} request.pageToken
751
- * The nextPageToken value received in the previous call to
752
- * migrationJobs.list, used in the subsequent request to retrieve the next
753
- * page of results. On first call this should be left blank. When paginating,
754
- * all other parameters provided to migrationJobs.list must match the call
755
- * that provided the page token.
756
- * @param {string} request.filter
757
- * A filter expression that filters migration jobs listed in the response.
758
- * The expression must specify the field name, a comparison operator, and the
759
- * value that you want to use for filtering. The value must be a string,
760
- * a number, or a boolean. The comparison operator must be
761
- * either =, !=, >, or <. For example, list migration jobs created this year
762
- * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
763
- * You can also filter nested fields. For example, you could specify
764
- * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
765
- * jobs connecting through the specific SSH tunnel bastion.
766
- * @param {string} request.orderBy
767
- * Sort the results based on the migration job name.
768
- * Valid values are: "name", "name asc", and "name desc".
849
+ * Required. The parent that owns the collection of PrivateConnections.
850
+ * @param {string} request.privateConnectionId
851
+ * Required. The private connection identifier.
852
+ * @param {google.cloud.clouddms.v1.PrivateConnection} request.privateConnection
853
+ * Required. The private connection resource to create.
854
+ * @param {string} [request.requestId]
855
+ * Optional. A unique ID used to identify the request. If the server receives
856
+ * two requests with the same ID, then the second request is ignored.
857
+ *
858
+ * It is recommended to always set this value to a UUID.
859
+ *
860
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
861
+ * (_), and hyphens (-). The maximum length is 40 characters.
862
+ * @param {boolean} [request.skipValidation]
863
+ * Optional. If set to true, will skip validations.
769
864
  * @param {object} [options]
770
865
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
771
866
  * @returns {Promise} - The promise which resolves to an array.
772
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}.
773
- * The client library will perform auto-pagination by default: it will call the API as many
774
- * times as needed and will merge results from all the pages into this array.
775
- * Note that it can affect your quota.
776
- * We recommend using `listMigrationJobsAsync()`
777
- * method described below for async iteration which you can stop as needed.
778
- * Please see the
779
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
867
+ * The first element of the array is an object representing
868
+ * a long running operation. Its `promise()` method returns a promise
869
+ * you can `await` for.
870
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
780
871
  * for more details and examples.
872
+ * @example <caption>include:samples/generated/v1/data_migration_service.create_private_connection.js</caption>
873
+ * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async
781
874
  */
782
- listMigrationJobs(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Promise<[
783
- protos.google.cloud.clouddms.v1.IMigrationJob[],
784
- protos.google.cloud.clouddms.v1.IListMigrationJobsRequest | null,
785
- protos.google.cloud.clouddms.v1.IListMigrationJobsResponse
875
+ createPrivateConnection(request?: protos.google.cloud.clouddms.v1.ICreatePrivateConnectionRequest, options?: CallOptions): Promise<[
876
+ LROperation<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IOperationMetadata>,
877
+ protos.google.longrunning.IOperation | undefined,
878
+ {} | undefined
786
879
  ]>;
787
- listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
788
- listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
880
+ createPrivateConnection(request: protos.google.cloud.clouddms.v1.ICreatePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
881
+ createPrivateConnection(request: protos.google.cloud.clouddms.v1.ICreatePrivateConnectionRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
789
882
  /**
790
- * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
883
+ * Check the status of the long running operation returned by `createPrivateConnection()`.
884
+ * @param {String} name
885
+ * The operation name that will be passed.
886
+ * @returns {Promise} - The promise which resolves to an object.
887
+ * The decoded operation object has result and metadata field to get information from.
888
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
889
+ * for more details and examples.
890
+ * @example <caption>include:samples/generated/v1/data_migration_service.create_private_connection.js</caption>
891
+ * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async
892
+ */
893
+ checkCreatePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.PrivateConnection, protos.google.cloud.clouddms.v1.OperationMetadata>>;
894
+ /**
895
+ * Deletes a single Database Migration Service private connection.
896
+ *
791
897
  * @param {Object} request
792
898
  * The request object that will be sent.
793
- * @param {string} request.parent
794
- * Required. The parent, which owns this collection of migrationJobs.
795
- * @param {number} request.pageSize
796
- * The maximum number of migration jobs to return. The service may return
797
- * fewer than this value. If unspecified, at most 50 migration jobs will be
798
- * returned. The maximum value is 1000; values above 1000 will be coerced to
799
- * 1000.
800
- * @param {string} request.pageToken
801
- * The nextPageToken value received in the previous call to
802
- * migrationJobs.list, used in the subsequent request to retrieve the next
803
- * page of results. On first call this should be left blank. When paginating,
804
- * all other parameters provided to migrationJobs.list must match the call
805
- * that provided the page token.
806
- * @param {string} request.filter
807
- * A filter expression that filters migration jobs listed in the response.
808
- * The expression must specify the field name, a comparison operator, and the
809
- * value that you want to use for filtering. The value must be a string,
810
- * a number, or a boolean. The comparison operator must be
811
- * either =, !=, >, or <. For example, list migration jobs created this year
812
- * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
813
- * You can also filter nested fields. For example, you could specify
814
- * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
815
- * jobs connecting through the specific SSH tunnel bastion.
816
- * @param {string} request.orderBy
817
- * Sort the results based on the migration job name.
818
- * Valid values are: "name", "name asc", and "name desc".
899
+ * @param {string} request.name
900
+ * Required. The name of the private connection to delete.
901
+ * @param {string} [request.requestId]
902
+ * Optional. A unique ID used to identify the request. If the server receives
903
+ * two requests with the same ID, then the second request is ignored.
904
+ *
905
+ * It is recommended to always set this value to a UUID.
906
+ *
907
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
908
+ * (_), and hyphens (-). The maximum length is 40 characters.
819
909
  * @param {object} [options]
820
910
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
821
- * @returns {Stream}
822
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob} on 'data' event.
823
- * The client library will perform auto-pagination by default: it will call the API as many
824
- * times as needed. Note that it can affect your quota.
825
- * We recommend using `listMigrationJobsAsync()`
826
- * method described below for async iteration which you can stop as needed.
827
- * Please see the
828
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
911
+ * @returns {Promise} - The promise which resolves to an array.
912
+ * The first element of the array is an object representing
913
+ * a long running operation. Its `promise()` method returns a promise
914
+ * you can `await` for.
915
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
829
916
  * for more details and examples.
917
+ * @example <caption>include:samples/generated/v1/data_migration_service.delete_private_connection.js</caption>
918
+ * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async
830
919
  */
831
- listMigrationJobsStream(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Transform;
920
+ deletePrivateConnection(request?: protos.google.cloud.clouddms.v1.IDeletePrivateConnectionRequest, options?: CallOptions): Promise<[
921
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>,
922
+ protos.google.longrunning.IOperation | undefined,
923
+ {} | undefined
924
+ ]>;
925
+ deletePrivateConnection(request: protos.google.cloud.clouddms.v1.IDeletePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
926
+ deletePrivateConnection(request: protos.google.cloud.clouddms.v1.IDeletePrivateConnectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
832
927
  /**
833
- * Equivalent to `listMigrationJobs`, but returns an iterable object.
928
+ * Check the status of the long running operation returned by `deletePrivateConnection()`.
929
+ * @param {String} name
930
+ * The operation name that will be passed.
931
+ * @returns {Promise} - The promise which resolves to an object.
932
+ * The decoded operation object has result and metadata field to get information from.
933
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
934
+ * for more details and examples.
935
+ * @example <caption>include:samples/generated/v1/data_migration_service.delete_private_connection.js</caption>
936
+ * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async
937
+ */
938
+ checkDeletePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
939
+ /**
940
+ * Creates a new conversion workspace in a given project and location.
834
941
  *
835
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
836
942
  * @param {Object} request
837
943
  * The request object that will be sent.
838
944
  * @param {string} request.parent
839
- * Required. The parent, which owns this collection of migrationJobs.
840
- * @param {number} request.pageSize
841
- * The maximum number of migration jobs to return. The service may return
842
- * fewer than this value. If unspecified, at most 50 migration jobs will be
843
- * returned. The maximum value is 1000; values above 1000 will be coerced to
844
- * 1000.
845
- * @param {string} request.pageToken
846
- * The nextPageToken value received in the previous call to
847
- * migrationJobs.list, used in the subsequent request to retrieve the next
848
- * page of results. On first call this should be left blank. When paginating,
849
- * all other parameters provided to migrationJobs.list must match the call
850
- * that provided the page token.
851
- * @param {string} request.filter
852
- * A filter expression that filters migration jobs listed in the response.
853
- * The expression must specify the field name, a comparison operator, and the
854
- * value that you want to use for filtering. The value must be a string,
855
- * a number, or a boolean. The comparison operator must be
856
- * either =, !=, >, or <. For example, list migration jobs created this year
857
- * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
858
- * You can also filter nested fields. For example, you could specify
859
- * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
860
- * jobs connecting through the specific SSH tunnel bastion.
861
- * @param {string} request.orderBy
862
- * Sort the results based on the migration job name.
863
- * Valid values are: "name", "name asc", and "name desc".
945
+ * Required. The parent which owns this collection of conversion workspaces.
946
+ * @param {string} request.conversionWorkspaceId
947
+ * Required. The ID of the conversion workspace to create.
948
+ * @param {google.cloud.clouddms.v1.ConversionWorkspace} request.conversionWorkspace
949
+ * Required. Represents a conversion workspace object.
950
+ * @param {string} request.requestId
951
+ * A unique ID used to identify the request. If the server receives two
952
+ * requests with the same ID, then the second request is ignored.
953
+ *
954
+ * It is recommended to always set this value to a UUID.
955
+ *
956
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
957
+ * (_), and hyphens (-). The maximum length is 40 characters.
864
958
  * @param {object} [options]
865
959
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
866
- * @returns {Object}
867
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
868
- * When you iterate the returned iterable, each element will be an object representing
869
- * {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}. The API will be called under the hood as needed, once per the page,
870
- * so you can stop the iteration when you don't need more results.
871
- * Please see the
872
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
960
+ * @returns {Promise} - The promise which resolves to an array.
961
+ * The first element of the array is an object representing
962
+ * a long running operation. Its `promise()` method returns a promise
963
+ * you can `await` for.
964
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
873
965
  * for more details and examples.
874
- * @example <caption>include:samples/generated/v1/data_migration_service.list_migration_jobs.js</caption>
875
- * region_tag:datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async
966
+ * @example <caption>include:samples/generated/v1/data_migration_service.create_conversion_workspace.js</caption>
967
+ * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async
876
968
  */
877
- listMigrationJobsAsync(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IMigrationJob>;
969
+ createConversionWorkspace(request?: protos.google.cloud.clouddms.v1.ICreateConversionWorkspaceRequest, options?: CallOptions): Promise<[
970
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
971
+ protos.google.longrunning.IOperation | undefined,
972
+ {} | undefined
973
+ ]>;
974
+ createConversionWorkspace(request: protos.google.cloud.clouddms.v1.ICreateConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
975
+ createConversionWorkspace(request: protos.google.cloud.clouddms.v1.ICreateConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
976
+ /**
977
+ * Check the status of the long running operation returned by `createConversionWorkspace()`.
978
+ * @param {String} name
979
+ * The operation name that will be passed.
980
+ * @returns {Promise} - The promise which resolves to an object.
981
+ * The decoded operation object has result and metadata field to get information from.
982
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
983
+ * for more details and examples.
984
+ * @example <caption>include:samples/generated/v1/data_migration_service.create_conversion_workspace.js</caption>
985
+ * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async
986
+ */
987
+ checkCreateConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
878
988
  /**
879
- * Retrieve a list of all connection profiles in a given project and location.
989
+ * Updates the parameters of a single conversion workspace.
880
990
  *
881
991
  * @param {Object} request
882
992
  * The request object that will be sent.
883
- * @param {string} request.parent
884
- * Required. The parent, which owns this collection of connection profiles.
885
- * @param {number} request.pageSize
886
- * The maximum number of connection profiles to return. The service may return
887
- * fewer than this value. If unspecified, at most 50 connection profiles will
888
- * be returned. The maximum value is 1000; values above 1000 will be coerced
889
- * to 1000.
890
- * @param {string} request.pageToken
891
- * A page token, received from a previous `ListConnectionProfiles` call.
892
- * Provide this to retrieve the subsequent page.
993
+ * @param {google.protobuf.FieldMask} request.updateMask
994
+ * Required. Field mask is used to specify the fields to be overwritten by the
995
+ * update in the conversion workspace resource.
996
+ * @param {google.cloud.clouddms.v1.ConversionWorkspace} request.conversionWorkspace
997
+ * Required. The conversion workspace parameters to update.
998
+ * @param {string} request.requestId
999
+ * A unique ID used to identify the request. If the server receives two
1000
+ * requests with the same ID, then the second request is ignored.
893
1001
  *
894
- * When paginating, all other parameters provided to `ListConnectionProfiles`
895
- * must match the call that provided the page token.
896
- * @param {string} request.filter
897
- * A filter expression that filters connection profiles listed in the
898
- * response. The expression must specify the field name, a comparison
899
- * operator, and the value that you want to use for filtering. The value must
900
- * be a string, a number, or a boolean. The comparison operator must be either
901
- * =, !=, >, or <. For example, list connection profiles created this year by
902
- * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
903
- * also filter nested fields. For example, you could specify **mySql.username
904
- * = %lt;my_username%gt;** to list all connection profiles configured to
905
- * connect with a specific username.
906
- * @param {string} request.orderBy
907
- * the order by fields for the result.
1002
+ * It is recommended to always set this value to a UUID.
1003
+ *
1004
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1005
+ * (_), and hyphens (-). The maximum length is 40 characters.
908
1006
  * @param {object} [options]
909
1007
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
910
1008
  * @returns {Promise} - The promise which resolves to an array.
911
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}.
912
- * The client library will perform auto-pagination by default: it will call the API as many
913
- * times as needed and will merge results from all the pages into this array.
914
- * Note that it can affect your quota.
915
- * We recommend using `listConnectionProfilesAsync()`
916
- * method described below for async iteration which you can stop as needed.
917
- * Please see the
918
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1009
+ * The first element of the array is an object representing
1010
+ * a long running operation. Its `promise()` method returns a promise
1011
+ * you can `await` for.
1012
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
919
1013
  * for more details and examples.
1014
+ * @example <caption>include:samples/generated/v1/data_migration_service.update_conversion_workspace.js</caption>
1015
+ * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async
920
1016
  */
921
- listConnectionProfiles(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Promise<[
922
- protos.google.cloud.clouddms.v1.IConnectionProfile[],
923
- protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest | null,
924
- protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse
1017
+ updateConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IUpdateConversionWorkspaceRequest, options?: CallOptions): Promise<[
1018
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1019
+ protos.google.longrunning.IOperation | undefined,
1020
+ {} | undefined
925
1021
  ]>;
926
- listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
927
- listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
1022
+ updateConversionWorkspace(request: protos.google.cloud.clouddms.v1.IUpdateConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1023
+ updateConversionWorkspace(request: protos.google.cloud.clouddms.v1.IUpdateConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
928
1024
  /**
929
- * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1025
+ * Check the status of the long running operation returned by `updateConversionWorkspace()`.
1026
+ * @param {String} name
1027
+ * The operation name that will be passed.
1028
+ * @returns {Promise} - The promise which resolves to an object.
1029
+ * The decoded operation object has result and metadata field to get information from.
1030
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1031
+ * for more details and examples.
1032
+ * @example <caption>include:samples/generated/v1/data_migration_service.update_conversion_workspace.js</caption>
1033
+ * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async
1034
+ */
1035
+ checkUpdateConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1036
+ /**
1037
+ * Deletes a single conversion workspace.
1038
+ *
930
1039
  * @param {Object} request
931
1040
  * The request object that will be sent.
932
- * @param {string} request.parent
933
- * Required. The parent, which owns this collection of connection profiles.
934
- * @param {number} request.pageSize
935
- * The maximum number of connection profiles to return. The service may return
1041
+ * @param {string} request.name
1042
+ * Required. Name of the conversion workspace resource to delete.
1043
+ * @param {string} request.requestId
1044
+ * A unique ID used to identify the request. If the server receives two
1045
+ * requests with the same ID, then the second request is ignored.
1046
+ *
1047
+ * It is recommended to always set this value to a UUID.
1048
+ *
1049
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1050
+ * (_), and hyphens (-). The maximum length is 40 characters.
1051
+ * @param {object} [options]
1052
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1053
+ * @returns {Promise} - The promise which resolves to an array.
1054
+ * The first element of the array is an object representing
1055
+ * a long running operation. Its `promise()` method returns a promise
1056
+ * you can `await` for.
1057
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1058
+ * for more details and examples.
1059
+ * @example <caption>include:samples/generated/v1/data_migration_service.delete_conversion_workspace.js</caption>
1060
+ * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async
1061
+ */
1062
+ deleteConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IDeleteConversionWorkspaceRequest, options?: CallOptions): Promise<[
1063
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1064
+ protos.google.longrunning.IOperation | undefined,
1065
+ {} | undefined
1066
+ ]>;
1067
+ deleteConversionWorkspace(request: protos.google.cloud.clouddms.v1.IDeleteConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1068
+ deleteConversionWorkspace(request: protos.google.cloud.clouddms.v1.IDeleteConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1069
+ /**
1070
+ * Check the status of the long running operation returned by `deleteConversionWorkspace()`.
1071
+ * @param {String} name
1072
+ * The operation name that will be passed.
1073
+ * @returns {Promise} - The promise which resolves to an object.
1074
+ * The decoded operation object has result and metadata field to get information from.
1075
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1076
+ * for more details and examples.
1077
+ * @example <caption>include:samples/generated/v1/data_migration_service.delete_conversion_workspace.js</caption>
1078
+ * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async
1079
+ */
1080
+ checkDeleteConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1081
+ /**
1082
+ * Imports a snapshot of the source database into the
1083
+ * conversion workspace.
1084
+ *
1085
+ * @param {Object} request
1086
+ * The request object that will be sent.
1087
+ * @param {string} request.name
1088
+ * Name of the conversion workspace resource to seed with new database
1089
+ * structure, in the form of:
1090
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1091
+ * @param {boolean} request.autoCommit
1092
+ * Should the conversion workspace be committed automatically after the
1093
+ * seed operation.
1094
+ * @param {string} request.sourceConnectionProfile
1095
+ * Fully qualified (Uri) name of the source connection profile.
1096
+ * @param {string} request.destinationConnectionProfile
1097
+ * Fully qualified (Uri) name of the destination connection profile.
1098
+ * @param {object} [options]
1099
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1100
+ * @returns {Promise} - The promise which resolves to an array.
1101
+ * The first element of the array is an object representing
1102
+ * a long running operation. Its `promise()` method returns a promise
1103
+ * you can `await` for.
1104
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1105
+ * for more details and examples.
1106
+ * @example <caption>include:samples/generated/v1/data_migration_service.seed_conversion_workspace.js</caption>
1107
+ * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async
1108
+ */
1109
+ seedConversionWorkspace(request?: protos.google.cloud.clouddms.v1.ISeedConversionWorkspaceRequest, options?: CallOptions): Promise<[
1110
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1111
+ protos.google.longrunning.IOperation | undefined,
1112
+ {} | undefined
1113
+ ]>;
1114
+ seedConversionWorkspace(request: protos.google.cloud.clouddms.v1.ISeedConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1115
+ seedConversionWorkspace(request: protos.google.cloud.clouddms.v1.ISeedConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1116
+ /**
1117
+ * Check the status of the long running operation returned by `seedConversionWorkspace()`.
1118
+ * @param {String} name
1119
+ * The operation name that will be passed.
1120
+ * @returns {Promise} - The promise which resolves to an object.
1121
+ * The decoded operation object has result and metadata field to get information from.
1122
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1123
+ * for more details and examples.
1124
+ * @example <caption>include:samples/generated/v1/data_migration_service.seed_conversion_workspace.js</caption>
1125
+ * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async
1126
+ */
1127
+ checkSeedConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1128
+ /**
1129
+ * Imports the mapping rules for a given conversion workspace.
1130
+ * Supports various formats of external rules files.
1131
+ *
1132
+ * @param {Object} request
1133
+ * The request object that will be sent.
1134
+ * @param {string} request.parent
1135
+ * Required. Name of the conversion workspace resource to import the rules to
1136
+ * in the form of:
1137
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1138
+ * @param {google.cloud.clouddms.v1.ImportRulesFileFormat} request.rulesFormat
1139
+ * The format of the rules content file.
1140
+ * @param {number[]} request.rulesFiles
1141
+ * One or more rules files.
1142
+ * @param {boolean} request.autoCommit
1143
+ * Should the conversion workspace be committed automatically after the
1144
+ * import operation.
1145
+ * @param {object} [options]
1146
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1147
+ * @returns {Promise} - The promise which resolves to an array.
1148
+ * The first element of the array is an object representing
1149
+ * a long running operation. Its `promise()` method returns a promise
1150
+ * you can `await` for.
1151
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1152
+ * for more details and examples.
1153
+ * @example <caption>include:samples/generated/v1/data_migration_service.import_mapping_rules.js</caption>
1154
+ * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async
1155
+ */
1156
+ importMappingRules(request?: protos.google.cloud.clouddms.v1.IImportMappingRulesRequest, options?: CallOptions): Promise<[
1157
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1158
+ protos.google.longrunning.IOperation | undefined,
1159
+ {} | undefined
1160
+ ]>;
1161
+ importMappingRules(request: protos.google.cloud.clouddms.v1.IImportMappingRulesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1162
+ importMappingRules(request: protos.google.cloud.clouddms.v1.IImportMappingRulesRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1163
+ /**
1164
+ * Check the status of the long running operation returned by `importMappingRules()`.
1165
+ * @param {String} name
1166
+ * The operation name that will be passed.
1167
+ * @returns {Promise} - The promise which resolves to an object.
1168
+ * The decoded operation object has result and metadata field to get information from.
1169
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1170
+ * for more details and examples.
1171
+ * @example <caption>include:samples/generated/v1/data_migration_service.import_mapping_rules.js</caption>
1172
+ * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async
1173
+ */
1174
+ checkImportMappingRulesProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1175
+ /**
1176
+ * Creates a draft tree schema for the destination database.
1177
+ *
1178
+ * @param {Object} request
1179
+ * The request object that will be sent.
1180
+ * @param {string} request.name
1181
+ * Name of the conversion workspace resource to convert in the form of:
1182
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1183
+ * @param {boolean} request.autoCommit
1184
+ * Specifies whether the conversion workspace is to be committed automatically
1185
+ * after the conversion.
1186
+ * @param {string} request.filter
1187
+ * Filter the entities to convert. Leaving this field empty will convert all
1188
+ * of the entities. Supports Google AIP-160 style filtering.
1189
+ * @param {object} [options]
1190
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1191
+ * @returns {Promise} - The promise which resolves to an array.
1192
+ * The first element of the array is an object representing
1193
+ * a long running operation. Its `promise()` method returns a promise
1194
+ * you can `await` for.
1195
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1196
+ * for more details and examples.
1197
+ * @example <caption>include:samples/generated/v1/data_migration_service.convert_conversion_workspace.js</caption>
1198
+ * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async
1199
+ */
1200
+ convertConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IConvertConversionWorkspaceRequest, options?: CallOptions): Promise<[
1201
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1202
+ protos.google.longrunning.IOperation | undefined,
1203
+ {} | undefined
1204
+ ]>;
1205
+ convertConversionWorkspace(request: protos.google.cloud.clouddms.v1.IConvertConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1206
+ convertConversionWorkspace(request: protos.google.cloud.clouddms.v1.IConvertConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1207
+ /**
1208
+ * Check the status of the long running operation returned by `convertConversionWorkspace()`.
1209
+ * @param {String} name
1210
+ * The operation name that will be passed.
1211
+ * @returns {Promise} - The promise which resolves to an object.
1212
+ * The decoded operation object has result and metadata field to get information from.
1213
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1214
+ * for more details and examples.
1215
+ * @example <caption>include:samples/generated/v1/data_migration_service.convert_conversion_workspace.js</caption>
1216
+ * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async
1217
+ */
1218
+ checkConvertConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1219
+ /**
1220
+ * Marks all the data in the conversion workspace as committed.
1221
+ *
1222
+ * @param {Object} request
1223
+ * The request object that will be sent.
1224
+ * @param {string} request.name
1225
+ * Required. Name of the conversion workspace resource to commit.
1226
+ * @param {string} [request.commitName]
1227
+ * Optional. Optional name of the commit.
1228
+ * @param {object} [options]
1229
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1230
+ * @returns {Promise} - The promise which resolves to an array.
1231
+ * The first element of the array is an object representing
1232
+ * a long running operation. Its `promise()` method returns a promise
1233
+ * you can `await` for.
1234
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1235
+ * for more details and examples.
1236
+ * @example <caption>include:samples/generated/v1/data_migration_service.commit_conversion_workspace.js</caption>
1237
+ * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async
1238
+ */
1239
+ commitConversionWorkspace(request?: protos.google.cloud.clouddms.v1.ICommitConversionWorkspaceRequest, options?: CallOptions): Promise<[
1240
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1241
+ protos.google.longrunning.IOperation | undefined,
1242
+ {} | undefined
1243
+ ]>;
1244
+ commitConversionWorkspace(request: protos.google.cloud.clouddms.v1.ICommitConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1245
+ commitConversionWorkspace(request: protos.google.cloud.clouddms.v1.ICommitConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1246
+ /**
1247
+ * Check the status of the long running operation returned by `commitConversionWorkspace()`.
1248
+ * @param {String} name
1249
+ * The operation name that will be passed.
1250
+ * @returns {Promise} - The promise which resolves to an object.
1251
+ * The decoded operation object has result and metadata field to get information from.
1252
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1253
+ * for more details and examples.
1254
+ * @example <caption>include:samples/generated/v1/data_migration_service.commit_conversion_workspace.js</caption>
1255
+ * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async
1256
+ */
1257
+ checkCommitConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1258
+ /**
1259
+ * Rolls back a conversion workspace to the last committed snapshot.
1260
+ *
1261
+ * @param {Object} request
1262
+ * The request object that will be sent.
1263
+ * @param {string} request.name
1264
+ * Required. Name of the conversion workspace resource to roll back to.
1265
+ * @param {object} [options]
1266
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1267
+ * @returns {Promise} - The promise which resolves to an array.
1268
+ * The first element of the array is an object representing
1269
+ * a long running operation. Its `promise()` method returns a promise
1270
+ * you can `await` for.
1271
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1272
+ * for more details and examples.
1273
+ * @example <caption>include:samples/generated/v1/data_migration_service.rollback_conversion_workspace.js</caption>
1274
+ * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async
1275
+ */
1276
+ rollbackConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IRollbackConversionWorkspaceRequest, options?: CallOptions): Promise<[
1277
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1278
+ protos.google.longrunning.IOperation | undefined,
1279
+ {} | undefined
1280
+ ]>;
1281
+ rollbackConversionWorkspace(request: protos.google.cloud.clouddms.v1.IRollbackConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1282
+ rollbackConversionWorkspace(request: protos.google.cloud.clouddms.v1.IRollbackConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1283
+ /**
1284
+ * Check the status of the long running operation returned by `rollbackConversionWorkspace()`.
1285
+ * @param {String} name
1286
+ * The operation name that will be passed.
1287
+ * @returns {Promise} - The promise which resolves to an object.
1288
+ * The decoded operation object has result and metadata field to get information from.
1289
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1290
+ * for more details and examples.
1291
+ * @example <caption>include:samples/generated/v1/data_migration_service.rollback_conversion_workspace.js</caption>
1292
+ * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async
1293
+ */
1294
+ checkRollbackConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1295
+ /**
1296
+ * Applies draft tree onto a specific destination database.
1297
+ *
1298
+ * @param {Object} request
1299
+ * The request object that will be sent.
1300
+ * @param {string} request.name
1301
+ * Required. The name of the conversion workspace resource for which to apply
1302
+ * the draft tree. Must be in the form of:
1303
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1304
+ * @param {string} request.filter
1305
+ * Filter which entities to apply. Leaving this field empty will apply all of
1306
+ * the entities. Supports Google AIP 160 based filtering.
1307
+ * @param {string} request.connectionProfile
1308
+ * Fully qualified (Uri) name of the destination connection profile.
1309
+ * @param {object} [options]
1310
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1311
+ * @returns {Promise} - The promise which resolves to an array.
1312
+ * The first element of the array is an object representing
1313
+ * a long running operation. Its `promise()` method returns a promise
1314
+ * you can `await` for.
1315
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1316
+ * for more details and examples.
1317
+ * @example <caption>include:samples/generated/v1/data_migration_service.apply_conversion_workspace.js</caption>
1318
+ * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async
1319
+ */
1320
+ applyConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IApplyConversionWorkspaceRequest, options?: CallOptions): Promise<[
1321
+ LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>,
1322
+ protos.google.longrunning.IOperation | undefined,
1323
+ {} | undefined
1324
+ ]>;
1325
+ applyConversionWorkspace(request: protos.google.cloud.clouddms.v1.IApplyConversionWorkspaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1326
+ applyConversionWorkspace(request: protos.google.cloud.clouddms.v1.IApplyConversionWorkspaceRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
1327
+ /**
1328
+ * Check the status of the long running operation returned by `applyConversionWorkspace()`.
1329
+ * @param {String} name
1330
+ * The operation name that will be passed.
1331
+ * @returns {Promise} - The promise which resolves to an object.
1332
+ * The decoded operation object has result and metadata field to get information from.
1333
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1334
+ * for more details and examples.
1335
+ * @example <caption>include:samples/generated/v1/data_migration_service.apply_conversion_workspace.js</caption>
1336
+ * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async
1337
+ */
1338
+ checkApplyConversionWorkspaceProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConversionWorkspace, protos.google.cloud.clouddms.v1.OperationMetadata>>;
1339
+ /**
1340
+ * Lists migration jobs in a given project and location.
1341
+ *
1342
+ * @param {Object} request
1343
+ * The request object that will be sent.
1344
+ * @param {string} request.parent
1345
+ * Required. The parent which owns this collection of migrationJobs.
1346
+ * @param {number} request.pageSize
1347
+ * The maximum number of migration jobs to return. The service may return
1348
+ * fewer than this value. If unspecified, at most 50 migration jobs will be
1349
+ * returned. The maximum value is 1000; values above 1000 are coerced to
1350
+ * 1000.
1351
+ * @param {string} request.pageToken
1352
+ * The nextPageToken value received in the previous call to
1353
+ * migrationJobs.list, used in the subsequent request to retrieve the next
1354
+ * page of results. On first call this should be left blank. When paginating,
1355
+ * all other parameters provided to migrationJobs.list must match the call
1356
+ * that provided the page token.
1357
+ * @param {string} request.filter
1358
+ * A filter expression that filters migration jobs listed in the response.
1359
+ * The expression must specify the field name, a comparison operator, and the
1360
+ * value that you want to use for filtering. The value must be a string,
1361
+ * a number, or a boolean. The comparison operator must be
1362
+ * either =, !=, >, or <. For example, list migration jobs created this year
1363
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
1364
+ * You can also filter nested fields. For example, you could specify
1365
+ * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
1366
+ * jobs connecting through the specific SSH tunnel bastion.
1367
+ * @param {string} request.orderBy
1368
+ * Sort the results based on the migration job name.
1369
+ * Valid values are: "name", "name asc", and "name desc".
1370
+ * @param {object} [options]
1371
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1372
+ * @returns {Promise} - The promise which resolves to an array.
1373
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}.
1374
+ * The client library will perform auto-pagination by default: it will call the API as many
1375
+ * times as needed and will merge results from all the pages into this array.
1376
+ * Note that it can affect your quota.
1377
+ * We recommend using `listMigrationJobsAsync()`
1378
+ * method described below for async iteration which you can stop as needed.
1379
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1380
+ * for more details and examples.
1381
+ */
1382
+ listMigrationJobs(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Promise<[
1383
+ protos.google.cloud.clouddms.v1.IMigrationJob[],
1384
+ protos.google.cloud.clouddms.v1.IListMigrationJobsRequest | null,
1385
+ protos.google.cloud.clouddms.v1.IListMigrationJobsResponse
1386
+ ]>;
1387
+ listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
1388
+ listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
1389
+ /**
1390
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1391
+ * @param {Object} request
1392
+ * The request object that will be sent.
1393
+ * @param {string} request.parent
1394
+ * Required. The parent which owns this collection of migrationJobs.
1395
+ * @param {number} request.pageSize
1396
+ * The maximum number of migration jobs to return. The service may return
1397
+ * fewer than this value. If unspecified, at most 50 migration jobs will be
1398
+ * returned. The maximum value is 1000; values above 1000 are coerced to
1399
+ * 1000.
1400
+ * @param {string} request.pageToken
1401
+ * The nextPageToken value received in the previous call to
1402
+ * migrationJobs.list, used in the subsequent request to retrieve the next
1403
+ * page of results. On first call this should be left blank. When paginating,
1404
+ * all other parameters provided to migrationJobs.list must match the call
1405
+ * that provided the page token.
1406
+ * @param {string} request.filter
1407
+ * A filter expression that filters migration jobs listed in the response.
1408
+ * The expression must specify the field name, a comparison operator, and the
1409
+ * value that you want to use for filtering. The value must be a string,
1410
+ * a number, or a boolean. The comparison operator must be
1411
+ * either =, !=, >, or <. For example, list migration jobs created this year
1412
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
1413
+ * You can also filter nested fields. For example, you could specify
1414
+ * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
1415
+ * jobs connecting through the specific SSH tunnel bastion.
1416
+ * @param {string} request.orderBy
1417
+ * Sort the results based on the migration job name.
1418
+ * Valid values are: "name", "name asc", and "name desc".
1419
+ * @param {object} [options]
1420
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1421
+ * @returns {Stream}
1422
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob} on 'data' event.
1423
+ * The client library will perform auto-pagination by default: it will call the API as many
1424
+ * times as needed. Note that it can affect your quota.
1425
+ * We recommend using `listMigrationJobsAsync()`
1426
+ * method described below for async iteration which you can stop as needed.
1427
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1428
+ * for more details and examples.
1429
+ */
1430
+ listMigrationJobsStream(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Transform;
1431
+ /**
1432
+ * Equivalent to `listMigrationJobs`, but returns an iterable object.
1433
+ *
1434
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1435
+ * @param {Object} request
1436
+ * The request object that will be sent.
1437
+ * @param {string} request.parent
1438
+ * Required. The parent which owns this collection of migrationJobs.
1439
+ * @param {number} request.pageSize
1440
+ * The maximum number of migration jobs to return. The service may return
1441
+ * fewer than this value. If unspecified, at most 50 migration jobs will be
1442
+ * returned. The maximum value is 1000; values above 1000 are coerced to
1443
+ * 1000.
1444
+ * @param {string} request.pageToken
1445
+ * The nextPageToken value received in the previous call to
1446
+ * migrationJobs.list, used in the subsequent request to retrieve the next
1447
+ * page of results. On first call this should be left blank. When paginating,
1448
+ * all other parameters provided to migrationJobs.list must match the call
1449
+ * that provided the page token.
1450
+ * @param {string} request.filter
1451
+ * A filter expression that filters migration jobs listed in the response.
1452
+ * The expression must specify the field name, a comparison operator, and the
1453
+ * value that you want to use for filtering. The value must be a string,
1454
+ * a number, or a boolean. The comparison operator must be
1455
+ * either =, !=, >, or <. For example, list migration jobs created this year
1456
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
1457
+ * You can also filter nested fields. For example, you could specify
1458
+ * **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
1459
+ * jobs connecting through the specific SSH tunnel bastion.
1460
+ * @param {string} request.orderBy
1461
+ * Sort the results based on the migration job name.
1462
+ * Valid values are: "name", "name asc", and "name desc".
1463
+ * @param {object} [options]
1464
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1465
+ * @returns {Object}
1466
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1467
+ * When you iterate the returned iterable, each element will be an object representing
1468
+ * {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}. The API will be called under the hood as needed, once per the page,
1469
+ * so you can stop the iteration when you don't need more results.
1470
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1471
+ * for more details and examples.
1472
+ * @example <caption>include:samples/generated/v1/data_migration_service.list_migration_jobs.js</caption>
1473
+ * region_tag:datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async
1474
+ */
1475
+ listMigrationJobsAsync(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IMigrationJob>;
1476
+ /**
1477
+ * Retrieves a list of all connection profiles in a given project and
1478
+ * location.
1479
+ *
1480
+ * @param {Object} request
1481
+ * The request object that will be sent.
1482
+ * @param {string} request.parent
1483
+ * Required. The parent which owns this collection of connection profiles.
1484
+ * @param {number} request.pageSize
1485
+ * The maximum number of connection profiles to return. The service may return
1486
+ * fewer than this value. If unspecified, at most 50 connection profiles will
1487
+ * be returned. The maximum value is 1000; values above 1000 are coerced
1488
+ * to 1000.
1489
+ * @param {string} request.pageToken
1490
+ * A page token, received from a previous `ListConnectionProfiles` call.
1491
+ * Provide this to retrieve the subsequent page.
1492
+ *
1493
+ * When paginating, all other parameters provided to `ListConnectionProfiles`
1494
+ * must match the call that provided the page token.
1495
+ * @param {string} request.filter
1496
+ * A filter expression that filters connection profiles listed in the
1497
+ * response. The expression must specify the field name, a comparison
1498
+ * operator, and the value that you want to use for filtering. The value must
1499
+ * be a string, a number, or a boolean. The comparison operator must be either
1500
+ * =, !=, >, or <. For example, list connection profiles created this year by
1501
+ * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
1502
+ * also filter nested fields. For example, you could specify **mySql.username
1503
+ * = %lt;my_username%gt;** to list all connection profiles configured to
1504
+ * connect with a specific username.
1505
+ * @param {string} request.orderBy
1506
+ * A comma-separated list of fields to order results according to.
1507
+ * @param {object} [options]
1508
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1509
+ * @returns {Promise} - The promise which resolves to an array.
1510
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}.
1511
+ * The client library will perform auto-pagination by default: it will call the API as many
1512
+ * times as needed and will merge results from all the pages into this array.
1513
+ * Note that it can affect your quota.
1514
+ * We recommend using `listConnectionProfilesAsync()`
1515
+ * method described below for async iteration which you can stop as needed.
1516
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1517
+ * for more details and examples.
1518
+ */
1519
+ listConnectionProfiles(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Promise<[
1520
+ protos.google.cloud.clouddms.v1.IConnectionProfile[],
1521
+ protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest | null,
1522
+ protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse
1523
+ ]>;
1524
+ listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
1525
+ listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
1526
+ /**
1527
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1528
+ * @param {Object} request
1529
+ * The request object that will be sent.
1530
+ * @param {string} request.parent
1531
+ * Required. The parent which owns this collection of connection profiles.
1532
+ * @param {number} request.pageSize
1533
+ * The maximum number of connection profiles to return. The service may return
1534
+ * fewer than this value. If unspecified, at most 50 connection profiles will
1535
+ * be returned. The maximum value is 1000; values above 1000 are coerced
1536
+ * to 1000.
1537
+ * @param {string} request.pageToken
1538
+ * A page token, received from a previous `ListConnectionProfiles` call.
1539
+ * Provide this to retrieve the subsequent page.
1540
+ *
1541
+ * When paginating, all other parameters provided to `ListConnectionProfiles`
1542
+ * must match the call that provided the page token.
1543
+ * @param {string} request.filter
1544
+ * A filter expression that filters connection profiles listed in the
1545
+ * response. The expression must specify the field name, a comparison
1546
+ * operator, and the value that you want to use for filtering. The value must
1547
+ * be a string, a number, or a boolean. The comparison operator must be either
1548
+ * =, !=, >, or <. For example, list connection profiles created this year by
1549
+ * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
1550
+ * also filter nested fields. For example, you could specify **mySql.username
1551
+ * = %lt;my_username%gt;** to list all connection profiles configured to
1552
+ * connect with a specific username.
1553
+ * @param {string} request.orderBy
1554
+ * A comma-separated list of fields to order results according to.
1555
+ * @param {object} [options]
1556
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1557
+ * @returns {Stream}
1558
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile} on 'data' event.
1559
+ * The client library will perform auto-pagination by default: it will call the API as many
1560
+ * times as needed. Note that it can affect your quota.
1561
+ * We recommend using `listConnectionProfilesAsync()`
1562
+ * method described below for async iteration which you can stop as needed.
1563
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1564
+ * for more details and examples.
1565
+ */
1566
+ listConnectionProfilesStream(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Transform;
1567
+ /**
1568
+ * Equivalent to `listConnectionProfiles`, but returns an iterable object.
1569
+ *
1570
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1571
+ * @param {Object} request
1572
+ * The request object that will be sent.
1573
+ * @param {string} request.parent
1574
+ * Required. The parent which owns this collection of connection profiles.
1575
+ * @param {number} request.pageSize
1576
+ * The maximum number of connection profiles to return. The service may return
936
1577
  * fewer than this value. If unspecified, at most 50 connection profiles will
937
- * be returned. The maximum value is 1000; values above 1000 will be coerced
1578
+ * be returned. The maximum value is 1000; values above 1000 are coerced
938
1579
  * to 1000.
939
1580
  * @param {string} request.pageToken
940
- * A page token, received from a previous `ListConnectionProfiles` call.
941
- * Provide this to retrieve the subsequent page.
942
- *
943
- * When paginating, all other parameters provided to `ListConnectionProfiles`
944
- * must match the call that provided the page token.
1581
+ * A page token, received from a previous `ListConnectionProfiles` call.
1582
+ * Provide this to retrieve the subsequent page.
1583
+ *
1584
+ * When paginating, all other parameters provided to `ListConnectionProfiles`
1585
+ * must match the call that provided the page token.
1586
+ * @param {string} request.filter
1587
+ * A filter expression that filters connection profiles listed in the
1588
+ * response. The expression must specify the field name, a comparison
1589
+ * operator, and the value that you want to use for filtering. The value must
1590
+ * be a string, a number, or a boolean. The comparison operator must be either
1591
+ * =, !=, >, or <. For example, list connection profiles created this year by
1592
+ * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
1593
+ * also filter nested fields. For example, you could specify **mySql.username
1594
+ * = %lt;my_username%gt;** to list all connection profiles configured to
1595
+ * connect with a specific username.
1596
+ * @param {string} request.orderBy
1597
+ * A comma-separated list of fields to order results according to.
1598
+ * @param {object} [options]
1599
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1600
+ * @returns {Object}
1601
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1602
+ * When you iterate the returned iterable, each element will be an object representing
1603
+ * {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}. The API will be called under the hood as needed, once per the page,
1604
+ * so you can stop the iteration when you don't need more results.
1605
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1606
+ * for more details and examples.
1607
+ * @example <caption>include:samples/generated/v1/data_migration_service.list_connection_profiles.js</caption>
1608
+ * region_tag:datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async
1609
+ */
1610
+ listConnectionProfilesAsync(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IConnectionProfile>;
1611
+ /**
1612
+ * Retrieves a list of private connections in a given project and location.
1613
+ *
1614
+ * @param {Object} request
1615
+ * The request object that will be sent.
1616
+ * @param {string} request.parent
1617
+ * Required. The parent that owns the collection of private connections.
1618
+ * @param {number} request.pageSize
1619
+ * Maximum number of private connections to return.
1620
+ * If unspecified, at most 50 private connections that are returned.
1621
+ * The maximum value is 1000; values above 1000 are coerced to 1000.
1622
+ * @param {string} request.pageToken
1623
+ * Page token received from a previous `ListPrivateConnections` call.
1624
+ * Provide this to retrieve the subsequent page.
1625
+ *
1626
+ * When paginating, all other parameters provided to
1627
+ * `ListPrivateConnections` must match the call that provided the page
1628
+ * token.
1629
+ * @param {string} request.filter
1630
+ * A filter expression that filters private connections listed in the
1631
+ * response. The expression must specify the field name, a comparison
1632
+ * operator, and the value that you want to use for filtering. The value must
1633
+ * be a string, a number, or a boolean. The comparison operator must be either
1634
+ * =, !=, >, or <. For example, list private connections created this year by
1635
+ * specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
1636
+ * @param {string} request.orderBy
1637
+ * Order by fields for the result.
1638
+ * @param {object} [options]
1639
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1640
+ * @returns {Promise} - The promise which resolves to an array.
1641
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}.
1642
+ * The client library will perform auto-pagination by default: it will call the API as many
1643
+ * times as needed and will merge results from all the pages into this array.
1644
+ * Note that it can affect your quota.
1645
+ * We recommend using `listPrivateConnectionsAsync()`
1646
+ * method described below for async iteration which you can stop as needed.
1647
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1648
+ * for more details and examples.
1649
+ */
1650
+ listPrivateConnections(request?: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options?: CallOptions): Promise<[
1651
+ protos.google.cloud.clouddms.v1.IPrivateConnection[],
1652
+ protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest | null,
1653
+ protos.google.cloud.clouddms.v1.IListPrivateConnectionsResponse
1654
+ ]>;
1655
+ listPrivateConnections(request: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, protos.google.cloud.clouddms.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.clouddms.v1.IPrivateConnection>): void;
1656
+ listPrivateConnections(request: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, protos.google.cloud.clouddms.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.clouddms.v1.IPrivateConnection>): void;
1657
+ /**
1658
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1659
+ * @param {Object} request
1660
+ * The request object that will be sent.
1661
+ * @param {string} request.parent
1662
+ * Required. The parent that owns the collection of private connections.
1663
+ * @param {number} request.pageSize
1664
+ * Maximum number of private connections to return.
1665
+ * If unspecified, at most 50 private connections that are returned.
1666
+ * The maximum value is 1000; values above 1000 are coerced to 1000.
1667
+ * @param {string} request.pageToken
1668
+ * Page token received from a previous `ListPrivateConnections` call.
1669
+ * Provide this to retrieve the subsequent page.
1670
+ *
1671
+ * When paginating, all other parameters provided to
1672
+ * `ListPrivateConnections` must match the call that provided the page
1673
+ * token.
1674
+ * @param {string} request.filter
1675
+ * A filter expression that filters private connections listed in the
1676
+ * response. The expression must specify the field name, a comparison
1677
+ * operator, and the value that you want to use for filtering. The value must
1678
+ * be a string, a number, or a boolean. The comparison operator must be either
1679
+ * =, !=, >, or <. For example, list private connections created this year by
1680
+ * specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
1681
+ * @param {string} request.orderBy
1682
+ * Order by fields for the result.
1683
+ * @param {object} [options]
1684
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1685
+ * @returns {Stream}
1686
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection} on 'data' event.
1687
+ * The client library will perform auto-pagination by default: it will call the API as many
1688
+ * times as needed. Note that it can affect your quota.
1689
+ * We recommend using `listPrivateConnectionsAsync()`
1690
+ * method described below for async iteration which you can stop as needed.
1691
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1692
+ * for more details and examples.
1693
+ */
1694
+ listPrivateConnectionsStream(request?: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options?: CallOptions): Transform;
1695
+ /**
1696
+ * Equivalent to `listPrivateConnections`, but returns an iterable object.
1697
+ *
1698
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1699
+ * @param {Object} request
1700
+ * The request object that will be sent.
1701
+ * @param {string} request.parent
1702
+ * Required. The parent that owns the collection of private connections.
1703
+ * @param {number} request.pageSize
1704
+ * Maximum number of private connections to return.
1705
+ * If unspecified, at most 50 private connections that are returned.
1706
+ * The maximum value is 1000; values above 1000 are coerced to 1000.
1707
+ * @param {string} request.pageToken
1708
+ * Page token received from a previous `ListPrivateConnections` call.
1709
+ * Provide this to retrieve the subsequent page.
1710
+ *
1711
+ * When paginating, all other parameters provided to
1712
+ * `ListPrivateConnections` must match the call that provided the page
1713
+ * token.
1714
+ * @param {string} request.filter
1715
+ * A filter expression that filters private connections listed in the
1716
+ * response. The expression must specify the field name, a comparison
1717
+ * operator, and the value that you want to use for filtering. The value must
1718
+ * be a string, a number, or a boolean. The comparison operator must be either
1719
+ * =, !=, >, or <. For example, list private connections created this year by
1720
+ * specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
1721
+ * @param {string} request.orderBy
1722
+ * Order by fields for the result.
1723
+ * @param {object} [options]
1724
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1725
+ * @returns {Object}
1726
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1727
+ * When you iterate the returned iterable, each element will be an object representing
1728
+ * {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}. The API will be called under the hood as needed, once per the page,
1729
+ * so you can stop the iteration when you don't need more results.
1730
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1731
+ * for more details and examples.
1732
+ * @example <caption>include:samples/generated/v1/data_migration_service.list_private_connections.js</caption>
1733
+ * region_tag:datamigration_v1_generated_DataMigrationService_ListPrivateConnections_async
1734
+ */
1735
+ listPrivateConnectionsAsync(request?: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IPrivateConnection>;
1736
+ /**
1737
+ * Lists conversion workspaces in a given project and location.
1738
+ *
1739
+ * @param {Object} request
1740
+ * The request object that will be sent.
1741
+ * @param {string} request.parent
1742
+ * Required. The parent which owns this collection of conversion workspaces.
1743
+ * @param {number} request.pageSize
1744
+ * The maximum number of conversion workspaces to return. The service may
1745
+ * return fewer than this value. If unspecified, at most 50 sets are returned.
1746
+ * @param {string} request.pageToken
1747
+ * The nextPageToken value received in the previous call to
1748
+ * conversionWorkspaces.list, used in the subsequent request to retrieve the
1749
+ * next page of results. On first call this should be left blank. When
1750
+ * paginating, all other parameters provided to conversionWorkspaces.list must
1751
+ * match the call that provided the page token.
1752
+ * @param {string} request.filter
1753
+ * A filter expression that filters conversion workspaces listed in the
1754
+ * response. The expression must specify the field name, a comparison
1755
+ * operator, and the value that you want to use for filtering. The value must
1756
+ * be a string, a number, or a boolean. The comparison operator must be either
1757
+ * =, !=, >, or <. For example, list conversion workspaces created this year
1758
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can
1759
+ * also filter nested fields. For example, you could specify
1760
+ * **source.version = "12.c.1"** to select all conversion workspaces with
1761
+ * source database version equal to 12.c.1.
1762
+ * @param {object} [options]
1763
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1764
+ * @returns {Promise} - The promise which resolves to an array.
1765
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}.
1766
+ * The client library will perform auto-pagination by default: it will call the API as many
1767
+ * times as needed and will merge results from all the pages into this array.
1768
+ * Note that it can affect your quota.
1769
+ * We recommend using `listConversionWorkspacesAsync()`
1770
+ * method described below for async iteration which you can stop as needed.
1771
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1772
+ * for more details and examples.
1773
+ */
1774
+ listConversionWorkspaces(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): Promise<[
1775
+ protos.google.cloud.clouddms.v1.IConversionWorkspace[],
1776
+ protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest | null,
1777
+ protos.google.cloud.clouddms.v1.IListConversionWorkspacesResponse
1778
+ ]>;
1779
+ listConversionWorkspaces(request: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, protos.google.cloud.clouddms.v1.IListConversionWorkspacesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConversionWorkspace>): void;
1780
+ listConversionWorkspaces(request: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, protos.google.cloud.clouddms.v1.IListConversionWorkspacesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConversionWorkspace>): void;
1781
+ /**
1782
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1783
+ * @param {Object} request
1784
+ * The request object that will be sent.
1785
+ * @param {string} request.parent
1786
+ * Required. The parent which owns this collection of conversion workspaces.
1787
+ * @param {number} request.pageSize
1788
+ * The maximum number of conversion workspaces to return. The service may
1789
+ * return fewer than this value. If unspecified, at most 50 sets are returned.
1790
+ * @param {string} request.pageToken
1791
+ * The nextPageToken value received in the previous call to
1792
+ * conversionWorkspaces.list, used in the subsequent request to retrieve the
1793
+ * next page of results. On first call this should be left blank. When
1794
+ * paginating, all other parameters provided to conversionWorkspaces.list must
1795
+ * match the call that provided the page token.
945
1796
  * @param {string} request.filter
946
- * A filter expression that filters connection profiles listed in the
1797
+ * A filter expression that filters conversion workspaces listed in the
947
1798
  * response. The expression must specify the field name, a comparison
948
1799
  * operator, and the value that you want to use for filtering. The value must
949
1800
  * be a string, a number, or a boolean. The comparison operator must be either
950
- * =, !=, >, or <. For example, list connection profiles created this year by
951
- * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
952
- * also filter nested fields. For example, you could specify **mySql.username
953
- * = %lt;my_username%gt;** to list all connection profiles configured to
954
- * connect with a specific username.
955
- * @param {string} request.orderBy
956
- * the order by fields for the result.
1801
+ * =, !=, >, or <. For example, list conversion workspaces created this year
1802
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can
1803
+ * also filter nested fields. For example, you could specify
1804
+ * **source.version = "12.c.1"** to select all conversion workspaces with
1805
+ * source database version equal to 12.c.1.
957
1806
  * @param {object} [options]
958
1807
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
959
1808
  * @returns {Stream}
960
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile} on 'data' event.
1809
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace} on 'data' event.
961
1810
  * The client library will perform auto-pagination by default: it will call the API as many
962
1811
  * times as needed. Note that it can affect your quota.
963
- * We recommend using `listConnectionProfilesAsync()`
1812
+ * We recommend using `listConversionWorkspacesAsync()`
964
1813
  * method described below for async iteration which you can stop as needed.
965
- * Please see the
966
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1814
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
967
1815
  * for more details and examples.
968
1816
  */
969
- listConnectionProfilesStream(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Transform;
1817
+ listConversionWorkspacesStream(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): Transform;
970
1818
  /**
971
- * Equivalent to `listConnectionProfiles`, but returns an iterable object.
1819
+ * Equivalent to `listConversionWorkspaces`, but returns an iterable object.
972
1820
  *
973
1821
  * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
974
1822
  * @param {Object} request
975
1823
  * The request object that will be sent.
976
1824
  * @param {string} request.parent
977
- * Required. The parent, which owns this collection of connection profiles.
1825
+ * Required. The parent which owns this collection of conversion workspaces.
978
1826
  * @param {number} request.pageSize
979
- * The maximum number of connection profiles to return. The service may return
980
- * fewer than this value. If unspecified, at most 50 connection profiles will
981
- * be returned. The maximum value is 1000; values above 1000 will be coerced
982
- * to 1000.
1827
+ * The maximum number of conversion workspaces to return. The service may
1828
+ * return fewer than this value. If unspecified, at most 50 sets are returned.
983
1829
  * @param {string} request.pageToken
984
- * A page token, received from a previous `ListConnectionProfiles` call.
985
- * Provide this to retrieve the subsequent page.
986
- *
987
- * When paginating, all other parameters provided to `ListConnectionProfiles`
988
- * must match the call that provided the page token.
1830
+ * The nextPageToken value received in the previous call to
1831
+ * conversionWorkspaces.list, used in the subsequent request to retrieve the
1832
+ * next page of results. On first call this should be left blank. When
1833
+ * paginating, all other parameters provided to conversionWorkspaces.list must
1834
+ * match the call that provided the page token.
989
1835
  * @param {string} request.filter
990
- * A filter expression that filters connection profiles listed in the
1836
+ * A filter expression that filters conversion workspaces listed in the
991
1837
  * response. The expression must specify the field name, a comparison
992
1838
  * operator, and the value that you want to use for filtering. The value must
993
1839
  * be a string, a number, or a boolean. The comparison operator must be either
994
- * =, !=, >, or <. For example, list connection profiles created this year by
995
- * specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
996
- * also filter nested fields. For example, you could specify **mySql.username
997
- * = %lt;my_username%gt;** to list all connection profiles configured to
998
- * connect with a specific username.
999
- * @param {string} request.orderBy
1000
- * the order by fields for the result.
1840
+ * =, !=, >, or <. For example, list conversion workspaces created this year
1841
+ * by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can
1842
+ * also filter nested fields. For example, you could specify
1843
+ * **source.version = "12.c.1"** to select all conversion workspaces with
1844
+ * source database version equal to 12.c.1.
1001
1845
  * @param {object} [options]
1002
1846
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1003
1847
  * @returns {Object}
1004
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
1848
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1005
1849
  * When you iterate the returned iterable, each element will be an object representing
1006
- * {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}. The API will be called under the hood as needed, once per the page,
1850
+ * {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}. The API will be called under the hood as needed, once per the page,
1007
1851
  * so you can stop the iteration when you don't need more results.
1008
- * Please see the
1009
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1852
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1010
1853
  * for more details and examples.
1011
- * @example <caption>include:samples/generated/v1/data_migration_service.list_connection_profiles.js</caption>
1012
- * region_tag:datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async
1854
+ * @example <caption>include:samples/generated/v1/data_migration_service.list_conversion_workspaces.js</caption>
1855
+ * region_tag:datamigration_v1_generated_DataMigrationService_ListConversionWorkspaces_async
1013
1856
  */
1014
- listConnectionProfilesAsync(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IConnectionProfile>;
1857
+ listConversionWorkspacesAsync(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IConversionWorkspace>;
1858
+ /**
1859
+ * Describes the database entities tree for a specific conversion workspace
1860
+ * and a specific tree type.
1861
+ *
1862
+ * Database entities are not resources like conversion workspaces or mapping
1863
+ * rules, and they can't be created, updated or deleted. Instead, they are
1864
+ * simple data objects describing the structure of the client database.
1865
+ *
1866
+ * @param {Object} request
1867
+ * The request object that will be sent.
1868
+ * @param {string} request.conversionWorkspace
1869
+ * Required. Name of the conversion workspace resource whose database entities
1870
+ * are described. Must be in the form of:
1871
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1872
+ * @param {number} request.pageSize
1873
+ * The maximum number of entities to return. The service may return
1874
+ * fewer entities than the value specifies.
1875
+ * @param {string} request.pageToken
1876
+ * The nextPageToken value received in the previous call to
1877
+ * conversionWorkspace.describeDatabaseEntities, used in the subsequent
1878
+ * request to retrieve the next page of results. On first call this should be
1879
+ * left blank. When paginating, all other parameters provided to
1880
+ * conversionWorkspace.describeDatabaseEntities must match the call that
1881
+ * provided the page token.
1882
+ * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
1883
+ * The tree to fetch.
1884
+ * @param {boolean} request.uncommitted
1885
+ * Whether to retrieve the latest committed version of the entities or the
1886
+ * latest version. This field is ignored if a specific commit_id is specified.
1887
+ * @param {string} request.commitId
1888
+ * Request a specific commit ID. If not specified, the entities from the
1889
+ * latest commit are returned.
1890
+ * @param {string} request.filter
1891
+ * Filter the returned entities based on AIP-160 standard.
1892
+ * @param {object} [options]
1893
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1894
+ * @returns {Promise} - The promise which resolves to an array.
1895
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}.
1896
+ * The client library will perform auto-pagination by default: it will call the API as many
1897
+ * times as needed and will merge results from all the pages into this array.
1898
+ * Note that it can affect your quota.
1899
+ * We recommend using `describeDatabaseEntitiesAsync()`
1900
+ * method described below for async iteration which you can stop as needed.
1901
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1902
+ * for more details and examples.
1903
+ */
1904
+ describeDatabaseEntities(request?: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options?: CallOptions): Promise<[
1905
+ protos.google.cloud.clouddms.v1.IDatabaseEntity[],
1906
+ protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest | null,
1907
+ protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesResponse
1908
+ ]>;
1909
+ describeDatabaseEntities(request: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesResponse | null | undefined, protos.google.cloud.clouddms.v1.IDatabaseEntity>): void;
1910
+ describeDatabaseEntities(request: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesResponse | null | undefined, protos.google.cloud.clouddms.v1.IDatabaseEntity>): void;
1911
+ /**
1912
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
1913
+ * @param {Object} request
1914
+ * The request object that will be sent.
1915
+ * @param {string} request.conversionWorkspace
1916
+ * Required. Name of the conversion workspace resource whose database entities
1917
+ * are described. Must be in the form of:
1918
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1919
+ * @param {number} request.pageSize
1920
+ * The maximum number of entities to return. The service may return
1921
+ * fewer entities than the value specifies.
1922
+ * @param {string} request.pageToken
1923
+ * The nextPageToken value received in the previous call to
1924
+ * conversionWorkspace.describeDatabaseEntities, used in the subsequent
1925
+ * request to retrieve the next page of results. On first call this should be
1926
+ * left blank. When paginating, all other parameters provided to
1927
+ * conversionWorkspace.describeDatabaseEntities must match the call that
1928
+ * provided the page token.
1929
+ * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
1930
+ * The tree to fetch.
1931
+ * @param {boolean} request.uncommitted
1932
+ * Whether to retrieve the latest committed version of the entities or the
1933
+ * latest version. This field is ignored if a specific commit_id is specified.
1934
+ * @param {string} request.commitId
1935
+ * Request a specific commit ID. If not specified, the entities from the
1936
+ * latest commit are returned.
1937
+ * @param {string} request.filter
1938
+ * Filter the returned entities based on AIP-160 standard.
1939
+ * @param {object} [options]
1940
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1941
+ * @returns {Stream}
1942
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity} on 'data' event.
1943
+ * The client library will perform auto-pagination by default: it will call the API as many
1944
+ * times as needed. Note that it can affect your quota.
1945
+ * We recommend using `describeDatabaseEntitiesAsync()`
1946
+ * method described below for async iteration which you can stop as needed.
1947
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1948
+ * for more details and examples.
1949
+ */
1950
+ describeDatabaseEntitiesStream(request?: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options?: CallOptions): Transform;
1951
+ /**
1952
+ * Equivalent to `describeDatabaseEntities`, but returns an iterable object.
1953
+ *
1954
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1955
+ * @param {Object} request
1956
+ * The request object that will be sent.
1957
+ * @param {string} request.conversionWorkspace
1958
+ * Required. Name of the conversion workspace resource whose database entities
1959
+ * are described. Must be in the form of:
1960
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1961
+ * @param {number} request.pageSize
1962
+ * The maximum number of entities to return. The service may return
1963
+ * fewer entities than the value specifies.
1964
+ * @param {string} request.pageToken
1965
+ * The nextPageToken value received in the previous call to
1966
+ * conversionWorkspace.describeDatabaseEntities, used in the subsequent
1967
+ * request to retrieve the next page of results. On first call this should be
1968
+ * left blank. When paginating, all other parameters provided to
1969
+ * conversionWorkspace.describeDatabaseEntities must match the call that
1970
+ * provided the page token.
1971
+ * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
1972
+ * The tree to fetch.
1973
+ * @param {boolean} request.uncommitted
1974
+ * Whether to retrieve the latest committed version of the entities or the
1975
+ * latest version. This field is ignored if a specific commit_id is specified.
1976
+ * @param {string} request.commitId
1977
+ * Request a specific commit ID. If not specified, the entities from the
1978
+ * latest commit are returned.
1979
+ * @param {string} request.filter
1980
+ * Filter the returned entities based on AIP-160 standard.
1981
+ * @param {object} [options]
1982
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1983
+ * @returns {Object}
1984
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1985
+ * When you iterate the returned iterable, each element will be an object representing
1986
+ * {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}. The API will be called under the hood as needed, once per the page,
1987
+ * so you can stop the iteration when you don't need more results.
1988
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1989
+ * for more details and examples.
1990
+ * @example <caption>include:samples/generated/v1/data_migration_service.describe_database_entities.js</caption>
1991
+ * region_tag:datamigration_v1_generated_DataMigrationService_DescribeDatabaseEntities_async
1992
+ */
1993
+ describeDatabaseEntitiesAsync(request?: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IDatabaseEntity>;
1994
+ /**
1995
+ * Fetches a set of static IP addresses that need to be allowlisted by the
1996
+ * customer when using the static-IP connectivity method.
1997
+ *
1998
+ * @param {Object} request
1999
+ * The request object that will be sent.
2000
+ * @param {string} request.name
2001
+ * Required. The resource name for the location for which static IPs should be
2002
+ * returned. Must be in the format `projects/* /locations/*`.
2003
+ * @param {number} request.pageSize
2004
+ * Maximum number of IPs to return.
2005
+ * @param {string} request.pageToken
2006
+ * A page token, received from a previous `FetchStaticIps` call.
2007
+ * @param {object} [options]
2008
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2009
+ * @returns {Promise} - The promise which resolves to an array.
2010
+ * The first element of the array is Array of string.
2011
+ * The client library will perform auto-pagination by default: it will call the API as many
2012
+ * times as needed and will merge results from all the pages into this array.
2013
+ * Note that it can affect your quota.
2014
+ * We recommend using `fetchStaticIpsAsync()`
2015
+ * method described below for async iteration which you can stop as needed.
2016
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2017
+ * for more details and examples.
2018
+ */
2019
+ fetchStaticIps(request?: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options?: CallOptions): Promise<[
2020
+ string[],
2021
+ protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest | null,
2022
+ protos.google.cloud.clouddms.v1.IFetchStaticIpsResponse
2023
+ ]>;
2024
+ fetchStaticIps(request: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, protos.google.cloud.clouddms.v1.IFetchStaticIpsResponse | null | undefined, string>): void;
2025
+ fetchStaticIps(request: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, protos.google.cloud.clouddms.v1.IFetchStaticIpsResponse | null | undefined, string>): void;
2026
+ /**
2027
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
2028
+ * @param {Object} request
2029
+ * The request object that will be sent.
2030
+ * @param {string} request.name
2031
+ * Required. The resource name for the location for which static IPs should be
2032
+ * returned. Must be in the format `projects/* /locations/*`.
2033
+ * @param {number} request.pageSize
2034
+ * Maximum number of IPs to return.
2035
+ * @param {string} request.pageToken
2036
+ * A page token, received from a previous `FetchStaticIps` call.
2037
+ * @param {object} [options]
2038
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2039
+ * @returns {Stream}
2040
+ * An object stream which emits an object representing string on 'data' event.
2041
+ * The client library will perform auto-pagination by default: it will call the API as many
2042
+ * times as needed. Note that it can affect your quota.
2043
+ * We recommend using `fetchStaticIpsAsync()`
2044
+ * method described below for async iteration which you can stop as needed.
2045
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2046
+ * for more details and examples.
2047
+ */
2048
+ fetchStaticIpsStream(request?: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options?: CallOptions): Transform;
2049
+ /**
2050
+ * Equivalent to `fetchStaticIps`, but returns an iterable object.
2051
+ *
2052
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2053
+ * @param {Object} request
2054
+ * The request object that will be sent.
2055
+ * @param {string} request.name
2056
+ * Required. The resource name for the location for which static IPs should be
2057
+ * returned. Must be in the format `projects/* /locations/*`.
2058
+ * @param {number} request.pageSize
2059
+ * Maximum number of IPs to return.
2060
+ * @param {string} request.pageToken
2061
+ * A page token, received from a previous `FetchStaticIps` call.
2062
+ * @param {object} [options]
2063
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2064
+ * @returns {Object}
2065
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2066
+ * When you iterate the returned iterable, each element will be an object representing
2067
+ * string. The API will be called under the hood as needed, once per the page,
2068
+ * so you can stop the iteration when you don't need more results.
2069
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2070
+ * for more details and examples.
2071
+ * @example <caption>include:samples/generated/v1/data_migration_service.fetch_static_ips.js</caption>
2072
+ * region_tag:datamigration_v1_generated_DataMigrationService_FetchStaticIps_async
2073
+ */
2074
+ fetchStaticIpsAsync(request?: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options?: CallOptions): AsyncIterable<string>;
2075
+ /**
2076
+ * Gets the access control policy for a resource. Returns an empty policy
2077
+ * if the resource exists and does not have a policy set.
2078
+ *
2079
+ * @param {Object} request
2080
+ * The request object that will be sent.
2081
+ * @param {string} request.resource
2082
+ * REQUIRED: The resource for which the policy is being requested.
2083
+ * See the operation documentation for the appropriate value for this field.
2084
+ * @param {Object} [request.options]
2085
+ * OPTIONAL: A `GetPolicyOptions` object for specifying options to
2086
+ * `GetIamPolicy`. This field is only used by Cloud IAM.
2087
+ *
2088
+ * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}.
2089
+ * @param {Object} [options]
2090
+ * Optional parameters. You can override the default settings for this call, e.g, timeout,
2091
+ * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
2092
+ * @param {function(?Error, ?Object)} [callback]
2093
+ * The function which will be called with the result of the API call.
2094
+ *
2095
+ * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}.
2096
+ * @returns {Promise} - The promise which resolves to an array.
2097
+ * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}.
2098
+ * The promise has a method named "cancel" which cancels the ongoing API call.
2099
+ */
2100
+ getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
2101
+ /**
2102
+ * Returns permissions that a caller has on the specified resource. If the
2103
+ * resource does not exist, this will return an empty set of
2104
+ * permissions, not a NOT_FOUND error.
2105
+ *
2106
+ * Note: This operation is designed to be used for building
2107
+ * permission-aware UIs and command-line tools, not for authorization
2108
+ * checking. This operation may "fail open" without warning.
2109
+ *
2110
+ * @param {Object} request
2111
+ * The request object that will be sent.
2112
+ * @param {string} request.resource
2113
+ * REQUIRED: The resource for which the policy detail is being requested.
2114
+ * See the operation documentation for the appropriate value for this field.
2115
+ * @param {string[]} request.permissions
2116
+ * The set of permissions to check for the `resource`. Permissions with
2117
+ * wildcards (such as '*' or 'storage.*') are not allowed. For more
2118
+ * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }.
2119
+ * @param {Object} [options]
2120
+ * Optional parameters. You can override the default settings for this call, e.g, timeout,
2121
+ * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
2122
+ * @param {function(?Error, ?Object)} [callback]
2123
+ * The function which will be called with the result of the API call.
2124
+ *
2125
+ * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}.
2126
+ * @returns {Promise} - The promise which resolves to an array.
2127
+ * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}.
2128
+ * The promise has a method named "cancel" which cancels the ongoing API call.
2129
+ */
2130
+ setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
2131
+ /**
2132
+ * Returns permissions that a caller has on the specified resource. If the
2133
+ * resource does not exist, this will return an empty set of
2134
+ * permissions, not a NOT_FOUND error.
2135
+ *
2136
+ * Note: This operation is designed to be used for building
2137
+ * permission-aware UIs and command-line tools, not for authorization
2138
+ * checking. This operation may "fail open" without warning.
2139
+ *
2140
+ * @param {Object} request
2141
+ * The request object that will be sent.
2142
+ * @param {string} request.resource
2143
+ * REQUIRED: The resource for which the policy detail is being requested.
2144
+ * See the operation documentation for the appropriate value for this field.
2145
+ * @param {string[]} request.permissions
2146
+ * The set of permissions to check for the `resource`. Permissions with
2147
+ * wildcards (such as '*' or 'storage.*') are not allowed. For more
2148
+ * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }.
2149
+ * @param {Object} [options]
2150
+ * Optional parameters. You can override the default settings for this call, e.g, timeout,
2151
+ * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
2152
+ * @param {function(?Error, ?Object)} [callback]
2153
+ * The function which will be called with the result of the API call.
2154
+ *
2155
+ * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}.
2156
+ * @returns {Promise} - The promise which resolves to an array.
2157
+ * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}.
2158
+ * The promise has a method named "cancel" which cancels the ongoing API call.
2159
+ *
2160
+ */
2161
+ testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;
2162
+ /**
2163
+ * Gets information about a location.
2164
+ *
2165
+ * @param {Object} request
2166
+ * The request object that will be sent.
2167
+ * @param {string} request.name
2168
+ * Resource name for the location.
2169
+ * @param {object} [options]
2170
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
2171
+ * @returns {Promise} - The promise which resolves to an array.
2172
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
2173
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
2174
+ * for more details and examples.
2175
+ * @example
2176
+ * ```
2177
+ * const [response] = await client.getLocation(request);
2178
+ * ```
2179
+ */
2180
+ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
2181
+ /**
2182
+ * Lists information about the supported locations for this service. Returns an iterable object.
2183
+ *
2184
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2185
+ * @param {Object} request
2186
+ * The request object that will be sent.
2187
+ * @param {string} request.name
2188
+ * The resource that owns the locations collection, if applicable.
2189
+ * @param {string} request.filter
2190
+ * The standard list filter.
2191
+ * @param {number} request.pageSize
2192
+ * The standard list page size.
2193
+ * @param {string} request.pageToken
2194
+ * The standard list page token.
2195
+ * @param {object} [options]
2196
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2197
+ * @returns {Object}
2198
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2199
+ * When you iterate the returned iterable, each element will be an object representing
2200
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
2201
+ * so you can stop the iteration when you don't need more results.
2202
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2203
+ * for more details and examples.
2204
+ * @example
2205
+ * ```
2206
+ * const iterable = client.listLocationsAsync(request);
2207
+ * for await (const response of iterable) {
2208
+ * // process response
2209
+ * }
2210
+ * ```
2211
+ */
2212
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
2213
+ /**
2214
+ * Gets the latest state of a long-running operation. Clients can use this
2215
+ * method to poll the operation result at intervals as recommended by the API
2216
+ * service.
2217
+ *
2218
+ * @param {Object} request - The request object that will be sent.
2219
+ * @param {string} request.name - The name of the operation resource.
2220
+ * @param {Object=} options
2221
+ * Optional parameters. You can override the default settings for this call,
2222
+ * e.g, timeout, retries, paginations, etc. See {@link
2223
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
2224
+ * for the details.
2225
+ * @param {function(?Error, ?Object)=} callback
2226
+ * The function which will be called with the result of the API call.
2227
+ *
2228
+ * The second parameter to the callback is an object representing
2229
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
2230
+ * @return {Promise} - The promise which resolves to an array.
2231
+ * The first element of the array is an object representing
2232
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
2233
+ * The promise has a method named "cancel" which cancels the ongoing API call.
2234
+ *
2235
+ * @example
2236
+ * ```
2237
+ * const client = longrunning.operationsClient();
2238
+ * const name = '';
2239
+ * const [response] = await client.getOperation({name});
2240
+ * // doThingsWith(response)
2241
+ * ```
2242
+ */
2243
+ getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
2244
+ /**
2245
+ * Lists operations that match the specified filter in the request. If the
2246
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
2247
+ *
2248
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
2249
+ *
2250
+ * @param {Object} request - The request object that will be sent.
2251
+ * @param {string} request.name - The name of the operation collection.
2252
+ * @param {string} request.filter - The standard list filter.
2253
+ * @param {number=} request.pageSize -
2254
+ * The maximum number of resources contained in the underlying API
2255
+ * response. If page streaming is performed per-resource, this
2256
+ * parameter does not affect the return value. If page streaming is
2257
+ * performed per-page, this determines the maximum number of
2258
+ * resources in a page.
2259
+ * @param {Object=} options
2260
+ * Optional parameters. You can override the default settings for this call,
2261
+ * e.g, timeout, retries, paginations, etc. See {@link
2262
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
2263
+ * details.
2264
+ * @returns {Object}
2265
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
2266
+ *
2267
+ * @example
2268
+ * ```
2269
+ * const client = longrunning.operationsClient();
2270
+ * for await (const response of client.listOperationsAsync(request));
2271
+ * // doThingsWith(response)
2272
+ * ```
2273
+ */
2274
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
2275
+ /**
2276
+ * Starts asynchronous cancellation on a long-running operation. The server
2277
+ * makes a best effort to cancel the operation, but success is not
2278
+ * guaranteed. If the server doesn't support this method, it returns
2279
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
2280
+ * {@link Operations.GetOperation} or
2281
+ * other methods to check whether the cancellation succeeded or whether the
2282
+ * operation completed despite cancellation. On successful cancellation,
2283
+ * the operation is not deleted; instead, it becomes an operation with
2284
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
2285
+ * 1, corresponding to `Code.CANCELLED`.
2286
+ *
2287
+ * @param {Object} request - The request object that will be sent.
2288
+ * @param {string} request.name - The name of the operation resource to be cancelled.
2289
+ * @param {Object=} options
2290
+ * Optional parameters. You can override the default settings for this call,
2291
+ * e.g, timeout, retries, paginations, etc. See {@link
2292
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
2293
+ * details.
2294
+ * @param {function(?Error)=} callback
2295
+ * The function which will be called with the result of the API call.
2296
+ * @return {Promise} - The promise which resolves when API call finishes.
2297
+ * The promise has a method named "cancel" which cancels the ongoing API
2298
+ * call.
2299
+ *
2300
+ * @example
2301
+ * ```
2302
+ * const client = longrunning.operationsClient();
2303
+ * await client.cancelOperation({name: ''});
2304
+ * ```
2305
+ */
2306
+ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
2307
+ /**
2308
+ * Deletes a long-running operation. This method indicates that the client is
2309
+ * no longer interested in the operation result. It does not cancel the
2310
+ * operation. If the server doesn't support this method, it returns
2311
+ * `google.rpc.Code.UNIMPLEMENTED`.
2312
+ *
2313
+ * @param {Object} request - The request object that will be sent.
2314
+ * @param {string} request.name - The name of the operation resource to be deleted.
2315
+ * @param {Object=} options
2316
+ * Optional parameters. You can override the default settings for this call,
2317
+ * e.g, timeout, retries, paginations, etc. See {@link
2318
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
2319
+ * for the details.
2320
+ * @param {function(?Error)=} callback
2321
+ * The function which will be called with the result of the API call.
2322
+ * @return {Promise} - The promise which resolves when API call finishes.
2323
+ * The promise has a method named "cancel" which cancels the ongoing API
2324
+ * call.
2325
+ *
2326
+ * @example
2327
+ * ```
2328
+ * const client = longrunning.operationsClient();
2329
+ * await client.deleteOperation({name: ''});
2330
+ * ```
2331
+ */
2332
+ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
1015
2333
  /**
1016
2334
  * Return a fully-qualified connectionProfile resource name string.
1017
2335
  *
@@ -1045,6 +2363,39 @@ export declare class DataMigrationServiceClient {
1045
2363
  * @returns {string} A string representing the connection_profile.
1046
2364
  */
1047
2365
  matchConnectionProfileFromConnectionProfileName(connectionProfileName: string): string | number;
2366
+ /**
2367
+ * Return a fully-qualified conversionWorkspace resource name string.
2368
+ *
2369
+ * @param {string} project
2370
+ * @param {string} location
2371
+ * @param {string} conversion_workspace
2372
+ * @returns {string} Resource name string.
2373
+ */
2374
+ conversionWorkspacePath(project: string, location: string, conversionWorkspace: string): string;
2375
+ /**
2376
+ * Parse the project from ConversionWorkspace resource.
2377
+ *
2378
+ * @param {string} conversionWorkspaceName
2379
+ * A fully-qualified path representing ConversionWorkspace resource.
2380
+ * @returns {string} A string representing the project.
2381
+ */
2382
+ matchProjectFromConversionWorkspaceName(conversionWorkspaceName: string): string | number;
2383
+ /**
2384
+ * Parse the location from ConversionWorkspace resource.
2385
+ *
2386
+ * @param {string} conversionWorkspaceName
2387
+ * A fully-qualified path representing ConversionWorkspace resource.
2388
+ * @returns {string} A string representing the location.
2389
+ */
2390
+ matchLocationFromConversionWorkspaceName(conversionWorkspaceName: string): string | number;
2391
+ /**
2392
+ * Parse the conversion_workspace from ConversionWorkspace resource.
2393
+ *
2394
+ * @param {string} conversionWorkspaceName
2395
+ * A fully-qualified path representing ConversionWorkspace resource.
2396
+ * @returns {string} A string representing the conversion_workspace.
2397
+ */
2398
+ matchConversionWorkspaceFromConversionWorkspaceName(conversionWorkspaceName: string): string | number;
1048
2399
  /**
1049
2400
  * Return a fully-qualified location resource name string.
1050
2401
  *
@@ -1102,6 +2453,39 @@ export declare class DataMigrationServiceClient {
1102
2453
  * @returns {string} A string representing the migration_job.
1103
2454
  */
1104
2455
  matchMigrationJobFromMigrationJobName(migrationJobName: string): string | number;
2456
+ /**
2457
+ * Return a fully-qualified privateConnection resource name string.
2458
+ *
2459
+ * @param {string} project
2460
+ * @param {string} location
2461
+ * @param {string} private_connection
2462
+ * @returns {string} Resource name string.
2463
+ */
2464
+ privateConnectionPath(project: string, location: string, privateConnection: string): string;
2465
+ /**
2466
+ * Parse the project from PrivateConnection resource.
2467
+ *
2468
+ * @param {string} privateConnectionName
2469
+ * A fully-qualified path representing PrivateConnection resource.
2470
+ * @returns {string} A string representing the project.
2471
+ */
2472
+ matchProjectFromPrivateConnectionName(privateConnectionName: string): string | number;
2473
+ /**
2474
+ * Parse the location from PrivateConnection resource.
2475
+ *
2476
+ * @param {string} privateConnectionName
2477
+ * A fully-qualified path representing PrivateConnection resource.
2478
+ * @returns {string} A string representing the location.
2479
+ */
2480
+ matchLocationFromPrivateConnectionName(privateConnectionName: string): string | number;
2481
+ /**
2482
+ * Parse the private_connection from PrivateConnection resource.
2483
+ *
2484
+ * @param {string} privateConnectionName
2485
+ * A fully-qualified path representing PrivateConnection resource.
2486
+ * @returns {string} A string representing the private_connection.
2487
+ */
2488
+ matchPrivateConnectionFromPrivateConnectionName(privateConnectionName: string): string | number;
1105
2489
  /**
1106
2490
  * Return a fully-qualified project resource name string.
1107
2491
  *