@google-cloud/dms 2.3.0 → 3.1.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.
@@ -59,8 +59,7 @@ export declare class DataMigrationServiceClient {
59
59
  * API remote host.
60
60
  * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
61
61
  * Follows the structure of {@link gapicConfig}.
62
- * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
63
- * Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
62
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
64
63
  * For more information, please check the
65
64
  * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
66
65
  * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -68,7 +67,7 @@ export declare class DataMigrationServiceClient {
68
67
  * HTTP implementation. Load only fallback version and pass it to the constructor:
69
68
  * ```
70
69
  * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
71
- * const client = new DataMigrationServiceClient({fallback: 'rest'}, gax);
70
+ * const client = new DataMigrationServiceClient({fallback: true}, gax);
72
71
  * ```
73
72
  */
74
73
  constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
@@ -120,9 +119,8 @@ export declare class DataMigrationServiceClient {
120
119
  * @param {object} [options]
121
120
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
122
121
  * @returns {Promise} - The promise which resolves to an array.
123
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}.
124
- * Please see the
125
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
122
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}.
123
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
126
124
  * for more details and examples.
127
125
  * @example <caption>include:samples/generated/v1/data_migration_service.get_migration_job.js</caption>
128
126
  * region_tag:datamigration_v1_generated_DataMigrationService_GetMigrationJob_async
@@ -153,9 +151,8 @@ export declare class DataMigrationServiceClient {
153
151
  * @param {object} [options]
154
152
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
155
153
  * @returns {Promise} - The promise which resolves to an array.
156
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.SshScript | SshScript}.
157
- * Please see the
158
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
154
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SshScript|SshScript}.
155
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
159
156
  * for more details and examples.
160
157
  * @example <caption>include:samples/generated/v1/data_migration_service.generate_ssh_script.js</caption>
161
158
  * region_tag:datamigration_v1_generated_DataMigrationService_GenerateSshScript_async
@@ -167,6 +164,44 @@ export declare class DataMigrationServiceClient {
167
164
  ]>;
168
165
  generateSshScript(request: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ISshScript, protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | null | undefined, {} | null | undefined>): void;
169
166
  generateSshScript(request: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, callback: Callback<protos.google.cloud.clouddms.v1.ISshScript, protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | null | undefined, {} | null | undefined>): void;
167
+ /**
168
+ * Generate a TCP Proxy configuration script to configure a cloud-hosted VM
169
+ * running a TCP Proxy.
170
+ *
171
+ * @param {Object} request
172
+ * The request object that will be sent.
173
+ * @param {string} request.migrationJob
174
+ * Name of the migration job resource to generate the TCP Proxy script.
175
+ * @param {string} request.vmName
176
+ * Required. The name of the Compute instance that will host the proxy.
177
+ * @param {string} request.vmMachineType
178
+ * Required. The type of the Compute instance that will host the proxy.
179
+ * @param {string} [request.vmZone]
180
+ * Optional. The Google Cloud Platform zone to create the VM in. The fully
181
+ * qualified name of the zone must be specified, including the region name,
182
+ * for example "us-central1-b". If not specified, uses the "-b" zone of the
183
+ * destination Connection Profile's region.
184
+ * @param {string} request.vmSubnet
185
+ * Required. The name of the subnet the Compute instance will use for private
186
+ * connectivity. Must be supplied in the form of
187
+ * projects/{project}/regions/{region}/subnetworks/{subnetwork}.
188
+ * Note: the region for the subnet must match the Compute instance region.
189
+ * @param {object} [options]
190
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
191
+ * @returns {Promise} - The promise which resolves to an array.
192
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.TcpProxyScript|TcpProxyScript}.
193
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
194
+ * for more details and examples.
195
+ * @example <caption>include:samples/generated/v1/data_migration_service.generate_tcp_proxy_script.js</caption>
196
+ * region_tag:datamigration_v1_generated_DataMigrationService_GenerateTcpProxyScript_async
197
+ */
198
+ generateTcpProxyScript(request?: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, options?: CallOptions): Promise<[
199
+ protos.google.cloud.clouddms.v1.ITcpProxyScript,
200
+ (protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | undefined),
201
+ {} | undefined
202
+ ]>;
203
+ generateTcpProxyScript(request: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ITcpProxyScript, protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | null | undefined, {} | null | undefined>): void;
204
+ generateTcpProxyScript(request: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, callback: Callback<protos.google.cloud.clouddms.v1.ITcpProxyScript, protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | null | undefined, {} | null | undefined>): void;
170
205
  /**
171
206
  * Gets details of a single connection profile.
172
207
  *
@@ -177,9 +212,8 @@ export declare class DataMigrationServiceClient {
177
212
  * @param {object} [options]
178
213
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
179
214
  * @returns {Promise} - The promise which resolves to an array.
180
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}.
181
- * Please see the
182
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
215
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}.
216
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
183
217
  * for more details and examples.
184
218
  * @example <caption>include:samples/generated/v1/data_migration_service.get_connection_profile.js</caption>
185
219
  * region_tag:datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async
@@ -201,9 +235,8 @@ export declare class DataMigrationServiceClient {
201
235
  * @param {object} [options]
202
236
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
203
237
  * @returns {Promise} - The promise which resolves to an array.
204
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.PrivateConnection | PrivateConnection}.
205
- * Please see the
206
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
238
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}.
239
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
207
240
  * for more details and examples.
208
241
  * @example <caption>include:samples/generated/v1/data_migration_service.get_private_connection.js</caption>
209
242
  * region_tag:datamigration_v1_generated_DataMigrationService_GetPrivateConnection_async
@@ -225,9 +258,8 @@ export declare class DataMigrationServiceClient {
225
258
  * @param {object} [options]
226
259
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
227
260
  * @returns {Promise} - The promise which resolves to an array.
228
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.ConversionWorkspace | ConversionWorkspace}.
229
- * Please see the
230
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
261
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}.
262
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
231
263
  * for more details and examples.
232
264
  * @example <caption>include:samples/generated/v1/data_migration_service.get_conversion_workspace.js</caption>
233
265
  * region_tag:datamigration_v1_generated_DataMigrationService_GetConversionWorkspace_async
@@ -239,6 +271,103 @@ export declare class DataMigrationServiceClient {
239
271
  ]>;
240
272
  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;
241
273
  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;
274
+ /**
275
+ * Creates a new mapping rule for a given conversion workspace.
276
+ *
277
+ * @param {Object} request
278
+ * The request object that will be sent.
279
+ * @param {string} request.parent
280
+ * Required. The parent which owns this collection of mapping rules.
281
+ * @param {string} request.mappingRuleId
282
+ * Required. The ID of the rule to create.
283
+ * @param {google.cloud.clouddms.v1.MappingRule} request.mappingRule
284
+ * Required. Represents a [mapping rule]
285
+ * (https://cloud.google.com/database-migration/reference/rest/v1/projects.locations.mappingRules)
286
+ * object.
287
+ * @param {string} request.requestId
288
+ * A unique ID used to identify the request. If the server receives two
289
+ * requests with the same ID, then the second request is ignored.
290
+ *
291
+ * It is recommended to always set this value to a UUID.
292
+ *
293
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
294
+ * (_), and hyphens (-). The maximum length is 40 characters.
295
+ * @param {object} [options]
296
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
297
+ * @returns {Promise} - The promise which resolves to an array.
298
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}.
299
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
300
+ * for more details and examples.
301
+ * @example <caption>include:samples/generated/v1/data_migration_service.create_mapping_rule.js</caption>
302
+ * region_tag:datamigration_v1_generated_DataMigrationService_CreateMappingRule_async
303
+ */
304
+ createMappingRule(request?: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, options?: CallOptions): Promise<[
305
+ protos.google.cloud.clouddms.v1.IMappingRule,
306
+ protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | undefined,
307
+ {} | undefined
308
+ ]>;
309
+ createMappingRule(request: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | null | undefined, {} | null | undefined>): void;
310
+ createMappingRule(request: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | null | undefined, {} | null | undefined>): void;
311
+ /**
312
+ * Deletes a single mapping rule.
313
+ *
314
+ * @param {Object} request
315
+ * The request object that will be sent.
316
+ * @param {string} request.name
317
+ * Required. Name of the mapping rule resource to delete.
318
+ * @param {string} [request.requestId]
319
+ * Optional. A unique ID used to identify the request. If the server receives
320
+ * two requests with the same ID, then the second request is ignored.
321
+ *
322
+ * It is recommended to always set this value to a UUID.
323
+ *
324
+ * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
325
+ * (_), and hyphens (-). The maximum length is 40 characters.
326
+ * @param {object} [options]
327
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
328
+ * @returns {Promise} - The promise which resolves to an array.
329
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
330
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
331
+ * for more details and examples.
332
+ * @example <caption>include:samples/generated/v1/data_migration_service.delete_mapping_rule.js</caption>
333
+ * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMappingRule_async
334
+ */
335
+ deleteMappingRule(request?: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, options?: CallOptions): Promise<[
336
+ protos.google.protobuf.IEmpty,
337
+ protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | undefined,
338
+ {} | undefined
339
+ ]>;
340
+ deleteMappingRule(request: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | null | undefined, {} | null | undefined>): void;
341
+ deleteMappingRule(request: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | null | undefined, {} | null | undefined>): void;
342
+ /**
343
+ * Gets the details of a mapping rule.
344
+ *
345
+ * @param {Object} request
346
+ * The request object that will be sent.
347
+ * @param {string} request.name
348
+ * Required. Name of the mapping rule resource to get.
349
+ * Example: conversionWorkspaces/123/mappingRules/rule123
350
+ *
351
+ * In order to retrieve a previous revision of the mapping rule, also provide
352
+ * the revision ID.
353
+ * Example:
354
+ * conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
355
+ * @param {object} [options]
356
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
357
+ * @returns {Promise} - The promise which resolves to an array.
358
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}.
359
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
360
+ * for more details and examples.
361
+ * @example <caption>include:samples/generated/v1/data_migration_service.get_mapping_rule.js</caption>
362
+ * region_tag:datamigration_v1_generated_DataMigrationService_GetMappingRule_async
363
+ */
364
+ getMappingRule(request?: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, options?: CallOptions): Promise<[
365
+ protos.google.cloud.clouddms.v1.IMappingRule,
366
+ protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | undefined,
367
+ {} | undefined
368
+ ]>;
369
+ getMappingRule(request: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | null | undefined, {} | null | undefined>): void;
370
+ getMappingRule(request: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | null | undefined, {} | null | undefined>): void;
242
371
  /**
243
372
  * Searches/lists the background jobs for a specific
244
373
  * conversion workspace.
@@ -266,9 +395,8 @@ export declare class DataMigrationServiceClient {
266
395
  * @param {object} [options]
267
396
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
268
397
  * @returns {Promise} - The promise which resolves to an array.
269
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.SearchBackgroundJobsResponse | SearchBackgroundJobsResponse}.
270
- * Please see the
271
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
398
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SearchBackgroundJobsResponse|SearchBackgroundJobsResponse}.
399
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
272
400
  * for more details and examples.
273
401
  * @example <caption>include:samples/generated/v1/data_migration_service.search_background_jobs.js</caption>
274
402
  * region_tag:datamigration_v1_generated_DataMigrationService_SearchBackgroundJobs_async
@@ -295,9 +423,8 @@ export declare class DataMigrationServiceClient {
295
423
  * @param {object} [options]
296
424
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
297
425
  * @returns {Promise} - The promise which resolves to an array.
298
- * The first element of the array is an object representing {@link google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse | DescribeConversionWorkspaceRevisionsResponse}.
299
- * Please see the
300
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
426
+ * The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse|DescribeConversionWorkspaceRevisionsResponse}.
427
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
301
428
  * for more details and examples.
302
429
  * @example <caption>include:samples/generated/v1/data_migration_service.describe_conversion_workspace_revisions.js</caption>
303
430
  * region_tag:datamigration_v1_generated_DataMigrationService_DescribeConversionWorkspaceRevisions_async
@@ -322,9 +449,9 @@ export declare class DataMigrationServiceClient {
322
449
  * Required. Represents a [migration
323
450
  * job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
324
451
  * object.
325
- * @param {string} request.requestId
326
- * A unique ID used to identify the request. If the server receives two
327
- * requests with the same ID, then the second request is ignored.
452
+ * @param {string} [request.requestId]
453
+ * Optional. A unique ID used to identify the request. If the server receives
454
+ * two requests with the same ID, then the second request is ignored.
328
455
  *
329
456
  * It is recommended to always set this value to a UUID.
330
457
  *
@@ -336,8 +463,7 @@ export declare class DataMigrationServiceClient {
336
463
  * The first element of the array is an object representing
337
464
  * a long running operation. Its `promise()` method returns a promise
338
465
  * you can `await` for.
339
- * Please see the
340
- * [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 }
341
467
  * for more details and examples.
342
468
  * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
343
469
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
@@ -355,8 +481,7 @@ export declare class DataMigrationServiceClient {
355
481
  * The operation name that will be passed.
356
482
  * @returns {Promise} - The promise which resolves to an object.
357
483
  * The decoded operation object has result and metadata field to get information from.
358
- * Please see the
359
- * [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 }
360
485
  * for more details and examples.
361
486
  * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
362
487
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
@@ -386,8 +511,7 @@ export declare class DataMigrationServiceClient {
386
511
  * The first element of the array is an object representing
387
512
  * a long running operation. Its `promise()` method returns a promise
388
513
  * you can `await` for.
389
- * Please see the
390
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
514
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
391
515
  * for more details and examples.
392
516
  * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
393
517
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
@@ -405,8 +529,7 @@ export declare class DataMigrationServiceClient {
405
529
  * The operation name that will be passed.
406
530
  * @returns {Promise} - The promise which resolves to an object.
407
531
  * The decoded operation object has result and metadata field to get information from.
408
- * Please see the
409
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
532
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
410
533
  * for more details and examples.
411
534
  * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
412
535
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
@@ -437,8 +560,7 @@ export declare class DataMigrationServiceClient {
437
560
  * The first element of the array is an object representing
438
561
  * a long running operation. Its `promise()` method returns a promise
439
562
  * you can `await` for.
440
- * Please see the
441
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
563
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
442
564
  * for more details and examples.
443
565
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
444
566
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
@@ -456,8 +578,7 @@ export declare class DataMigrationServiceClient {
456
578
  * The operation name that will be passed.
457
579
  * @returns {Promise} - The promise which resolves to an object.
458
580
  * The decoded operation object has result and metadata field to get information from.
459
- * Please see the
460
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
581
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
461
582
  * for more details and examples.
462
583
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
463
584
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
@@ -470,14 +591,16 @@ export declare class DataMigrationServiceClient {
470
591
  * The request object that will be sent.
471
592
  * @param {string} request.name
472
593
  * Name of the migration job resource to start.
594
+ * @param {boolean} [request.skipValidation]
595
+ * Optional. Start the migration job without running prior configuration
596
+ * verification. Defaults to `false`.
473
597
  * @param {object} [options]
474
598
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
475
599
  * @returns {Promise} - The promise which resolves to an array.
476
600
  * The first element of the array is an object representing
477
601
  * a long running operation. Its `promise()` method returns a promise
478
602
  * you can `await` for.
479
- * Please see the
480
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
603
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
481
604
  * for more details and examples.
482
605
  * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
483
606
  * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
@@ -495,8 +618,7 @@ export declare class DataMigrationServiceClient {
495
618
  * The operation name that will be passed.
496
619
  * @returns {Promise} - The promise which resolves to an object.
497
620
  * The decoded operation object has result and metadata field to get information from.
498
- * Please see the
499
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
621
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
500
622
  * for more details and examples.
501
623
  * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
502
624
  * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
@@ -515,8 +637,7 @@ export declare class DataMigrationServiceClient {
515
637
  * The first element of the array is an object representing
516
638
  * a long running operation. Its `promise()` method returns a promise
517
639
  * you can `await` for.
518
- * Please see the
519
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
640
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
520
641
  * for more details and examples.
521
642
  * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
522
643
  * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
@@ -534,8 +655,7 @@ export declare class DataMigrationServiceClient {
534
655
  * The operation name that will be passed.
535
656
  * @returns {Promise} - The promise which resolves to an object.
536
657
  * 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)
658
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
539
659
  * for more details and examples.
540
660
  * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
541
661
  * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
@@ -555,8 +675,7 @@ export declare class DataMigrationServiceClient {
555
675
  * The first element of the array is an object representing
556
676
  * a long running operation. Its `promise()` method returns a promise
557
677
  * you can `await` for.
558
- * Please see the
559
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
678
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
560
679
  * for more details and examples.
561
680
  * @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
562
681
  * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
@@ -574,8 +693,7 @@ export declare class DataMigrationServiceClient {
574
693
  * The operation name that will be passed.
575
694
  * @returns {Promise} - The promise which resolves to an object.
576
695
  * The decoded operation object has result and metadata field to get information from.
577
- * Please see the
578
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
696
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
579
697
  * for more details and examples.
580
698
  * @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
581
699
  * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
@@ -595,8 +713,7 @@ export declare class DataMigrationServiceClient {
595
713
  * The first element of the array is an object representing
596
714
  * a long running operation. Its `promise()` method returns a promise
597
715
  * you can `await` for.
598
- * Please see the
599
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
716
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
600
717
  * for more details and examples.
601
718
  * @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
602
719
  * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
@@ -614,8 +731,7 @@ export declare class DataMigrationServiceClient {
614
731
  * The operation name that will be passed.
615
732
  * @returns {Promise} - The promise which resolves to an object.
616
733
  * The decoded operation object has result and metadata field to get information from.
617
- * Please see the
618
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
734
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
619
735
  * for more details and examples.
620
736
  * @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
621
737
  * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
@@ -629,14 +745,19 @@ export declare class DataMigrationServiceClient {
629
745
  * The request object that will be sent.
630
746
  * @param {string} request.name
631
747
  * Name of the migration job resource to verify.
748
+ * @param {google.protobuf.FieldMask} [request.updateMask]
749
+ * Optional. Field mask is used to specify the changed fields to be verified.
750
+ * It will not update the migration job.
751
+ * @param {google.cloud.clouddms.v1.MigrationJob} [request.migrationJob]
752
+ * Optional. The changed migration job parameters to verify.
753
+ * It will not update the migration job.
632
754
  * @param {object} [options]
633
755
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
634
756
  * @returns {Promise} - The promise which resolves to an array.
635
757
  * The first element of the array is an object representing
636
758
  * a long running operation. Its `promise()` method returns a promise
637
759
  * you can `await` for.
638
- * Please see the
639
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
760
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
640
761
  * for more details and examples.
641
762
  * @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
642
763
  * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
@@ -654,8 +775,7 @@ export declare class DataMigrationServiceClient {
654
775
  * The operation name that will be passed.
655
776
  * @returns {Promise} - The promise which resolves to an object.
656
777
  * The decoded operation object has result and metadata field to get information from.
657
- * Please see the
658
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
778
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
659
779
  * for more details and examples.
660
780
  * @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
661
781
  * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
@@ -670,14 +790,16 @@ export declare class DataMigrationServiceClient {
670
790
  * The request object that will be sent.
671
791
  * @param {string} request.name
672
792
  * Name of the migration job resource to restart.
793
+ * @param {boolean} [request.skipValidation]
794
+ * Optional. Restart the migration job without running prior configuration
795
+ * verification. Defaults to `false`.
673
796
  * @param {object} [options]
674
797
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
675
798
  * @returns {Promise} - The promise which resolves to an array.
676
799
  * The first element of the array is an object representing
677
800
  * a long running operation. Its `promise()` method returns a promise
678
801
  * you can `await` for.
679
- * Please see the
680
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
802
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
681
803
  * for more details and examples.
682
804
  * @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
683
805
  * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
@@ -695,8 +817,7 @@ export declare class DataMigrationServiceClient {
695
817
  * The operation name that will be passed.
696
818
  * @returns {Promise} - The promise which resolves to an object.
697
819
  * The decoded operation object has result and metadata field to get information from.
698
- * Please see the
699
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
820
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
700
821
  * for more details and examples.
701
822
  * @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
702
823
  * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
@@ -735,8 +856,7 @@ export declare class DataMigrationServiceClient {
735
856
  * The first element of the array is an object representing
736
857
  * a long running operation. Its `promise()` method returns a promise
737
858
  * you can `await` for.
738
- * Please see the
739
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
859
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
740
860
  * for more details and examples.
741
861
  * @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
742
862
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
@@ -754,8 +874,7 @@ export declare class DataMigrationServiceClient {
754
874
  * The operation name that will be passed.
755
875
  * @returns {Promise} - The promise which resolves to an object.
756
876
  * The decoded operation object has result and metadata field to get information from.
757
- * Please see the
758
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
877
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
759
878
  * for more details and examples.
760
879
  * @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
761
880
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
@@ -793,8 +912,7 @@ export declare class DataMigrationServiceClient {
793
912
  * The first element of the array is an object representing
794
913
  * a long running operation. Its `promise()` method returns a promise
795
914
  * you can `await` for.
796
- * Please see the
797
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
915
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
798
916
  * for more details and examples.
799
917
  * @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
800
918
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
@@ -812,8 +930,7 @@ export declare class DataMigrationServiceClient {
812
930
  * The operation name that will be passed.
813
931
  * @returns {Promise} - The promise which resolves to an object.
814
932
  * The decoded operation object has result and metadata field to get information from.
815
- * Please see the
816
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
933
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
817
934
  * for more details and examples.
818
935
  * @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
819
936
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
@@ -845,8 +962,7 @@ export declare class DataMigrationServiceClient {
845
962
  * The first element of the array is an object representing
846
963
  * a long running operation. Its `promise()` method returns a promise
847
964
  * you can `await` for.
848
- * Please see the
849
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
965
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
850
966
  * for more details and examples.
851
967
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
852
968
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
@@ -864,8 +980,7 @@ export declare class DataMigrationServiceClient {
864
980
  * The operation name that will be passed.
865
981
  * @returns {Promise} - The promise which resolves to an object.
866
982
  * The decoded operation object has result and metadata field to get information from.
867
- * Please see the
868
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
983
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
869
984
  * for more details and examples.
870
985
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
871
986
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
@@ -898,8 +1013,7 @@ export declare class DataMigrationServiceClient {
898
1013
  * The first element of the array is an object representing
899
1014
  * a long running operation. Its `promise()` method returns a promise
900
1015
  * you can `await` for.
901
- * Please see the
902
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1016
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
903
1017
  * for more details and examples.
904
1018
  * @example <caption>include:samples/generated/v1/data_migration_service.create_private_connection.js</caption>
905
1019
  * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async
@@ -917,8 +1031,7 @@ export declare class DataMigrationServiceClient {
917
1031
  * The operation name that will be passed.
918
1032
  * @returns {Promise} - The promise which resolves to an object.
919
1033
  * The decoded operation object has result and metadata field to get information from.
920
- * Please see the
921
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1034
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
922
1035
  * for more details and examples.
923
1036
  * @example <caption>include:samples/generated/v1/data_migration_service.create_private_connection.js</caption>
924
1037
  * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async
@@ -945,8 +1058,7 @@ export declare class DataMigrationServiceClient {
945
1058
  * The first element of the array is an object representing
946
1059
  * a long running operation. Its `promise()` method returns a promise
947
1060
  * you can `await` for.
948
- * Please see the
949
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1061
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
950
1062
  * for more details and examples.
951
1063
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_private_connection.js</caption>
952
1064
  * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async
@@ -964,8 +1076,7 @@ export declare class DataMigrationServiceClient {
964
1076
  * The operation name that will be passed.
965
1077
  * @returns {Promise} - The promise which resolves to an object.
966
1078
  * The decoded operation object has result and metadata field to get information from.
967
- * Please see the
968
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1079
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
969
1080
  * for more details and examples.
970
1081
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_private_connection.js</caption>
971
1082
  * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async
@@ -996,8 +1107,7 @@ export declare class DataMigrationServiceClient {
996
1107
  * The first element of the array is an object representing
997
1108
  * a long running operation. Its `promise()` method returns a promise
998
1109
  * you can `await` for.
999
- * Please see the
1000
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1110
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1001
1111
  * for more details and examples.
1002
1112
  * @example <caption>include:samples/generated/v1/data_migration_service.create_conversion_workspace.js</caption>
1003
1113
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async
@@ -1015,8 +1125,7 @@ export declare class DataMigrationServiceClient {
1015
1125
  * The operation name that will be passed.
1016
1126
  * @returns {Promise} - The promise which resolves to an object.
1017
1127
  * The decoded operation object has result and metadata field to get information from.
1018
- * Please see the
1019
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1128
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1020
1129
  * for more details and examples.
1021
1130
  * @example <caption>include:samples/generated/v1/data_migration_service.create_conversion_workspace.js</caption>
1022
1131
  * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async
@@ -1046,8 +1155,7 @@ export declare class DataMigrationServiceClient {
1046
1155
  * The first element of the array is an object representing
1047
1156
  * a long running operation. Its `promise()` method returns a promise
1048
1157
  * you can `await` for.
1049
- * Please see the
1050
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1158
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1051
1159
  * for more details and examples.
1052
1160
  * @example <caption>include:samples/generated/v1/data_migration_service.update_conversion_workspace.js</caption>
1053
1161
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async
@@ -1065,8 +1173,7 @@ export declare class DataMigrationServiceClient {
1065
1173
  * The operation name that will be passed.
1066
1174
  * @returns {Promise} - The promise which resolves to an object.
1067
1175
  * The decoded operation object has result and metadata field to get information from.
1068
- * Please see the
1069
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1176
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1070
1177
  * for more details and examples.
1071
1178
  * @example <caption>include:samples/generated/v1/data_migration_service.update_conversion_workspace.js</caption>
1072
1179
  * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async
@@ -1087,14 +1194,16 @@ export declare class DataMigrationServiceClient {
1087
1194
  *
1088
1195
  * The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1089
1196
  * (_), and hyphens (-). The maximum length is 40 characters.
1197
+ * @param {boolean} request.force
1198
+ * Force delete the conversion workspace, even if there's a running migration
1199
+ * that is using the workspace.
1090
1200
  * @param {object} [options]
1091
1201
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1092
1202
  * @returns {Promise} - The promise which resolves to an array.
1093
1203
  * The first element of the array is an object representing
1094
1204
  * a long running operation. Its `promise()` method returns a promise
1095
1205
  * you can `await` for.
1096
- * Please see the
1097
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1206
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1098
1207
  * for more details and examples.
1099
1208
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_conversion_workspace.js</caption>
1100
1209
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async
@@ -1112,8 +1221,7 @@ export declare class DataMigrationServiceClient {
1112
1221
  * The operation name that will be passed.
1113
1222
  * @returns {Promise} - The promise which resolves to an object.
1114
1223
  * The decoded operation object has result and metadata field to get information from.
1115
- * Please see the
1116
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1224
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1117
1225
  * for more details and examples.
1118
1226
  * @example <caption>include:samples/generated/v1/data_migration_service.delete_conversion_workspace.js</caption>
1119
1227
  * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async
@@ -1132,18 +1240,18 @@ export declare class DataMigrationServiceClient {
1132
1240
  * @param {boolean} request.autoCommit
1133
1241
  * Should the conversion workspace be committed automatically after the
1134
1242
  * seed operation.
1135
- * @param {string} request.sourceConnectionProfile
1136
- * Fully qualified (Uri) name of the source connection profile.
1137
- * @param {string} request.destinationConnectionProfile
1138
- * Fully qualified (Uri) name of the destination connection profile.
1243
+ * @param {string} [request.sourceConnectionProfile]
1244
+ * Optional. Fully qualified (Uri) name of the source connection profile.
1245
+ * @param {string} [request.destinationConnectionProfile]
1246
+ * Optional. Fully qualified (Uri) name of the destination connection
1247
+ * profile.
1139
1248
  * @param {object} [options]
1140
1249
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1141
1250
  * @returns {Promise} - The promise which resolves to an array.
1142
1251
  * The first element of the array is an object representing
1143
1252
  * a long running operation. Its `promise()` method returns a promise
1144
1253
  * you can `await` for.
1145
- * Please see the
1146
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1254
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1147
1255
  * for more details and examples.
1148
1256
  * @example <caption>include:samples/generated/v1/data_migration_service.seed_conversion_workspace.js</caption>
1149
1257
  * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async
@@ -1161,8 +1269,7 @@ export declare class DataMigrationServiceClient {
1161
1269
  * The operation name that will be passed.
1162
1270
  * @returns {Promise} - The promise which resolves to an object.
1163
1271
  * The decoded operation object has result and metadata field to get information from.
1164
- * Please see the
1165
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1272
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1166
1273
  * for more details and examples.
1167
1274
  * @example <caption>include:samples/generated/v1/data_migration_service.seed_conversion_workspace.js</caption>
1168
1275
  * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async
@@ -1179,20 +1286,19 @@ export declare class DataMigrationServiceClient {
1179
1286
  * in the form of:
1180
1287
  * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1181
1288
  * @param {google.cloud.clouddms.v1.ImportRulesFileFormat} request.rulesFormat
1182
- * The format of the rules content file.
1289
+ * Required. The format of the rules content file.
1183
1290
  * @param {number[]} request.rulesFiles
1184
- * One or more rules files.
1291
+ * Required. One or more rules files.
1185
1292
  * @param {boolean} request.autoCommit
1186
- * Should the conversion workspace be committed automatically after the
1187
- * import operation.
1293
+ * Required. Should the conversion workspace be committed automatically after
1294
+ * the import operation.
1188
1295
  * @param {object} [options]
1189
1296
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1190
1297
  * @returns {Promise} - The promise which resolves to an array.
1191
1298
  * The first element of the array is an object representing
1192
1299
  * a long running operation. Its `promise()` method returns a promise
1193
1300
  * you can `await` for.
1194
- * Please see the
1195
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1301
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1196
1302
  * for more details and examples.
1197
1303
  * @example <caption>include:samples/generated/v1/data_migration_service.import_mapping_rules.js</caption>
1198
1304
  * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async
@@ -1210,8 +1316,7 @@ export declare class DataMigrationServiceClient {
1210
1316
  * The operation name that will be passed.
1211
1317
  * @returns {Promise} - The promise which resolves to an object.
1212
1318
  * The decoded operation object has result and metadata field to get information from.
1213
- * Please see the
1214
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1319
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1215
1320
  * for more details and examples.
1216
1321
  * @example <caption>include:samples/generated/v1/data_migration_service.import_mapping_rules.js</caption>
1217
1322
  * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async
@@ -1225,20 +1330,23 @@ export declare class DataMigrationServiceClient {
1225
1330
  * @param {string} request.name
1226
1331
  * Name of the conversion workspace resource to convert in the form of:
1227
1332
  * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1228
- * @param {boolean} request.autoCommit
1229
- * Specifies whether the conversion workspace is to be committed automatically
1230
- * after the conversion.
1231
- * @param {string} request.filter
1232
- * Filter the entities to convert. Leaving this field empty will convert all
1233
- * of the entities. Supports Google AIP-160 style filtering.
1333
+ * @param {boolean} [request.autoCommit]
1334
+ * Optional. Specifies whether the conversion workspace is to be committed
1335
+ * automatically after the conversion.
1336
+ * @param {string} [request.filter]
1337
+ * Optional. Filter the entities to convert. Leaving this field empty will
1338
+ * convert all of the entities. Supports Google AIP-160 style filtering.
1339
+ * @param {boolean} [request.convertFullPath]
1340
+ * Optional. Automatically convert the full entity path for each entity
1341
+ * specified by the filter. For example, if the filter specifies a table, that
1342
+ * table schema (and database if there is one) will also be converted.
1234
1343
  * @param {object} [options]
1235
1344
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1236
1345
  * @returns {Promise} - The promise which resolves to an array.
1237
1346
  * The first element of the array is an object representing
1238
1347
  * a long running operation. Its `promise()` method returns a promise
1239
1348
  * you can `await` for.
1240
- * Please see the
1241
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1349
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1242
1350
  * for more details and examples.
1243
1351
  * @example <caption>include:samples/generated/v1/data_migration_service.convert_conversion_workspace.js</caption>
1244
1352
  * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async
@@ -1256,8 +1364,7 @@ export declare class DataMigrationServiceClient {
1256
1364
  * The operation name that will be passed.
1257
1365
  * @returns {Promise} - The promise which resolves to an object.
1258
1366
  * The decoded operation object has result and metadata field to get information from.
1259
- * Please see the
1260
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1367
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1261
1368
  * for more details and examples.
1262
1369
  * @example <caption>include:samples/generated/v1/data_migration_service.convert_conversion_workspace.js</caption>
1263
1370
  * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async
@@ -1278,8 +1385,7 @@ export declare class DataMigrationServiceClient {
1278
1385
  * The first element of the array is an object representing
1279
1386
  * a long running operation. Its `promise()` method returns a promise
1280
1387
  * you can `await` for.
1281
- * Please see the
1282
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1388
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1283
1389
  * for more details and examples.
1284
1390
  * @example <caption>include:samples/generated/v1/data_migration_service.commit_conversion_workspace.js</caption>
1285
1391
  * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async
@@ -1297,8 +1403,7 @@ export declare class DataMigrationServiceClient {
1297
1403
  * The operation name that will be passed.
1298
1404
  * @returns {Promise} - The promise which resolves to an object.
1299
1405
  * The decoded operation object has result and metadata field to get information from.
1300
- * Please see the
1301
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1406
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1302
1407
  * for more details and examples.
1303
1408
  * @example <caption>include:samples/generated/v1/data_migration_service.commit_conversion_workspace.js</caption>
1304
1409
  * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async
@@ -1317,8 +1422,7 @@ export declare class DataMigrationServiceClient {
1317
1422
  * The first element of the array is an object representing
1318
1423
  * a long running operation. Its `promise()` method returns a promise
1319
1424
  * you can `await` for.
1320
- * Please see the
1321
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1425
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1322
1426
  * for more details and examples.
1323
1427
  * @example <caption>include:samples/generated/v1/data_migration_service.rollback_conversion_workspace.js</caption>
1324
1428
  * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async
@@ -1336,8 +1440,7 @@ export declare class DataMigrationServiceClient {
1336
1440
  * The operation name that will be passed.
1337
1441
  * @returns {Promise} - The promise which resolves to an object.
1338
1442
  * The decoded operation object has result and metadata field to get information from.
1339
- * Please see the
1340
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1443
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1341
1444
  * for more details and examples.
1342
1445
  * @example <caption>include:samples/generated/v1/data_migration_service.rollback_conversion_workspace.js</caption>
1343
1446
  * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async
@@ -1355,16 +1458,23 @@ export declare class DataMigrationServiceClient {
1355
1458
  * @param {string} request.filter
1356
1459
  * Filter which entities to apply. Leaving this field empty will apply all of
1357
1460
  * the entities. Supports Google AIP 160 based filtering.
1358
- * @param {string} request.connectionProfile
1359
- * Fully qualified (Uri) name of the destination connection profile.
1461
+ * @param {boolean} [request.dryRun]
1462
+ * Optional. Only validates the apply process, but doesn't change the
1463
+ * destination database. Only works for PostgreSQL destination connection
1464
+ * profile.
1465
+ * @param {boolean} [request.autoCommit]
1466
+ * Optional. Specifies whether the conversion workspace is to be committed
1467
+ * automatically after the apply.
1468
+ * @param {string} [request.connectionProfile]
1469
+ * Optional. Fully qualified (Uri) name of the destination connection
1470
+ * profile.
1360
1471
  * @param {object} [options]
1361
1472
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1362
1473
  * @returns {Promise} - The promise which resolves to an array.
1363
1474
  * The first element of the array is an object representing
1364
1475
  * a long running operation. Its `promise()` method returns a promise
1365
1476
  * you can `await` for.
1366
- * Please see the
1367
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1477
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1368
1478
  * for more details and examples.
1369
1479
  * @example <caption>include:samples/generated/v1/data_migration_service.apply_conversion_workspace.js</caption>
1370
1480
  * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async
@@ -1382,8 +1492,7 @@ export declare class DataMigrationServiceClient {
1382
1492
  * The operation name that will be passed.
1383
1493
  * @returns {Promise} - The promise which resolves to an object.
1384
1494
  * The decoded operation object has result and metadata field to get information from.
1385
- * Please see the
1386
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1495
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
1387
1496
  * for more details and examples.
1388
1497
  * @example <caption>include:samples/generated/v1/data_migration_service.apply_conversion_workspace.js</caption>
1389
1498
  * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async
@@ -1423,14 +1532,13 @@ export declare class DataMigrationServiceClient {
1423
1532
  * @param {object} [options]
1424
1533
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1425
1534
  * @returns {Promise} - The promise which resolves to an array.
1426
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}.
1535
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}.
1427
1536
  * The client library will perform auto-pagination by default: it will call the API as many
1428
1537
  * times as needed and will merge results from all the pages into this array.
1429
1538
  * Note that it can affect your quota.
1430
1539
  * We recommend using `listMigrationJobsAsync()`
1431
1540
  * method described below for async iteration which you can stop as needed.
1432
- * Please see the
1433
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1541
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1434
1542
  * for more details and examples.
1435
1543
  */
1436
1544
  listMigrationJobs(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Promise<[
@@ -1473,13 +1581,12 @@ export declare class DataMigrationServiceClient {
1473
1581
  * @param {object} [options]
1474
1582
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1475
1583
  * @returns {Stream}
1476
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob} on 'data' event.
1584
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob} on 'data' event.
1477
1585
  * The client library will perform auto-pagination by default: it will call the API as many
1478
1586
  * times as needed. Note that it can affect your quota.
1479
1587
  * We recommend using `listMigrationJobsAsync()`
1480
1588
  * method described below for async iteration which you can stop as needed.
1481
- * Please see the
1482
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1589
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1483
1590
  * for more details and examples.
1484
1591
  */
1485
1592
  listMigrationJobsStream(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Transform;
@@ -1518,12 +1625,11 @@ export declare class DataMigrationServiceClient {
1518
1625
  * @param {object} [options]
1519
1626
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1520
1627
  * @returns {Object}
1521
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
1628
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1522
1629
  * When you iterate the returned iterable, each element will be an object representing
1523
- * {@link google.cloud.clouddms.v1.MigrationJob | MigrationJob}. The API will be called under the hood as needed, once per the page,
1630
+ * {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}. The API will be called under the hood as needed, once per the page,
1524
1631
  * so you can stop the iteration when you don't need more results.
1525
- * Please see the
1526
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1632
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1527
1633
  * for more details and examples.
1528
1634
  * @example <caption>include:samples/generated/v1/data_migration_service.list_migration_jobs.js</caption>
1529
1635
  * region_tag:datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async
@@ -1563,14 +1669,13 @@ export declare class DataMigrationServiceClient {
1563
1669
  * @param {object} [options]
1564
1670
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1565
1671
  * @returns {Promise} - The promise which resolves to an array.
1566
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}.
1672
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}.
1567
1673
  * The client library will perform auto-pagination by default: it will call the API as many
1568
1674
  * times as needed and will merge results from all the pages into this array.
1569
1675
  * Note that it can affect your quota.
1570
1676
  * We recommend using `listConnectionProfilesAsync()`
1571
1677
  * method described below for async iteration which you can stop as needed.
1572
- * Please see the
1573
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1678
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1574
1679
  * for more details and examples.
1575
1680
  */
1576
1681
  listConnectionProfiles(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Promise<[
@@ -1612,13 +1717,12 @@ export declare class DataMigrationServiceClient {
1612
1717
  * @param {object} [options]
1613
1718
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1614
1719
  * @returns {Stream}
1615
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile} on 'data' event.
1720
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile} on 'data' event.
1616
1721
  * The client library will perform auto-pagination by default: it will call the API as many
1617
1722
  * times as needed. Note that it can affect your quota.
1618
1723
  * We recommend using `listConnectionProfilesAsync()`
1619
1724
  * method described below for async iteration which you can stop as needed.
1620
- * Please see the
1621
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1725
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1622
1726
  * for more details and examples.
1623
1727
  */
1624
1728
  listConnectionProfilesStream(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Transform;
@@ -1656,12 +1760,11 @@ export declare class DataMigrationServiceClient {
1656
1760
  * @param {object} [options]
1657
1761
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1658
1762
  * @returns {Object}
1659
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
1763
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1660
1764
  * When you iterate the returned iterable, each element will be an object representing
1661
- * {@link google.cloud.clouddms.v1.ConnectionProfile | ConnectionProfile}. The API will be called under the hood as needed, once per the page,
1765
+ * {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}. The API will be called under the hood as needed, once per the page,
1662
1766
  * so you can stop the iteration when you don't need more results.
1663
- * Please see the
1664
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1767
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1665
1768
  * for more details and examples.
1666
1769
  * @example <caption>include:samples/generated/v1/data_migration_service.list_connection_profiles.js</caption>
1667
1770
  * region_tag:datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async
@@ -1697,14 +1800,13 @@ export declare class DataMigrationServiceClient {
1697
1800
  * @param {object} [options]
1698
1801
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1699
1802
  * @returns {Promise} - The promise which resolves to an array.
1700
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.PrivateConnection | PrivateConnection}.
1803
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}.
1701
1804
  * The client library will perform auto-pagination by default: it will call the API as many
1702
1805
  * times as needed and will merge results from all the pages into this array.
1703
1806
  * Note that it can affect your quota.
1704
1807
  * We recommend using `listPrivateConnectionsAsync()`
1705
1808
  * method described below for async iteration which you can stop as needed.
1706
- * Please see the
1707
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1809
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1708
1810
  * for more details and examples.
1709
1811
  */
1710
1812
  listPrivateConnections(request?: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options?: CallOptions): Promise<[
@@ -1743,13 +1845,12 @@ export declare class DataMigrationServiceClient {
1743
1845
  * @param {object} [options]
1744
1846
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1745
1847
  * @returns {Stream}
1746
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.PrivateConnection | PrivateConnection} on 'data' event.
1848
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection} on 'data' event.
1747
1849
  * The client library will perform auto-pagination by default: it will call the API as many
1748
1850
  * times as needed. Note that it can affect your quota.
1749
1851
  * We recommend using `listPrivateConnectionsAsync()`
1750
1852
  * method described below for async iteration which you can stop as needed.
1751
- * Please see the
1752
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1853
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1753
1854
  * for more details and examples.
1754
1855
  */
1755
1856
  listPrivateConnectionsStream(request?: protos.google.cloud.clouddms.v1.IListPrivateConnectionsRequest, options?: CallOptions): Transform;
@@ -1784,12 +1885,11 @@ export declare class DataMigrationServiceClient {
1784
1885
  * @param {object} [options]
1785
1886
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1786
1887
  * @returns {Object}
1787
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
1888
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1788
1889
  * When you iterate the returned iterable, each element will be an object representing
1789
- * {@link google.cloud.clouddms.v1.PrivateConnection | PrivateConnection}. The API will be called under the hood as needed, once per the page,
1890
+ * {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}. The API will be called under the hood as needed, once per the page,
1790
1891
  * so you can stop the iteration when you don't need more results.
1791
- * Please see the
1792
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1892
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1793
1893
  * for more details and examples.
1794
1894
  * @example <caption>include:samples/generated/v1/data_migration_service.list_private_connections.js</caption>
1795
1895
  * region_tag:datamigration_v1_generated_DataMigrationService_ListPrivateConnections_async
@@ -1824,14 +1924,13 @@ export declare class DataMigrationServiceClient {
1824
1924
  * @param {object} [options]
1825
1925
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1826
1926
  * @returns {Promise} - The promise which resolves to an array.
1827
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.ConversionWorkspace | ConversionWorkspace}.
1927
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}.
1828
1928
  * The client library will perform auto-pagination by default: it will call the API as many
1829
1929
  * times as needed and will merge results from all the pages into this array.
1830
1930
  * Note that it can affect your quota.
1831
1931
  * We recommend using `listConversionWorkspacesAsync()`
1832
1932
  * method described below for async iteration which you can stop as needed.
1833
- * Please see the
1834
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1933
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1835
1934
  * for more details and examples.
1836
1935
  */
1837
1936
  listConversionWorkspaces(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): Promise<[
@@ -1869,13 +1968,12 @@ export declare class DataMigrationServiceClient {
1869
1968
  * @param {object} [options]
1870
1969
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1871
1970
  * @returns {Stream}
1872
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.ConversionWorkspace | ConversionWorkspace} on 'data' event.
1971
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace} on 'data' event.
1873
1972
  * The client library will perform auto-pagination by default: it will call the API as many
1874
1973
  * times as needed. Note that it can affect your quota.
1875
1974
  * We recommend using `listConversionWorkspacesAsync()`
1876
1975
  * method described below for async iteration which you can stop as needed.
1877
- * Please see the
1878
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1976
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1879
1977
  * for more details and examples.
1880
1978
  */
1881
1979
  listConversionWorkspacesStream(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): Transform;
@@ -1909,17 +2007,114 @@ export declare class DataMigrationServiceClient {
1909
2007
  * @param {object} [options]
1910
2008
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1911
2009
  * @returns {Object}
1912
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
2010
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1913
2011
  * When you iterate the returned iterable, each element will be an object representing
1914
- * {@link google.cloud.clouddms.v1.ConversionWorkspace | ConversionWorkspace}. The API will be called under the hood as needed, once per the page,
2012
+ * {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}. The API will be called under the hood as needed, once per the page,
1915
2013
  * so you can stop the iteration when you don't need more results.
1916
- * Please see the
1917
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2014
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1918
2015
  * for more details and examples.
1919
2016
  * @example <caption>include:samples/generated/v1/data_migration_service.list_conversion_workspaces.js</caption>
1920
2017
  * region_tag:datamigration_v1_generated_DataMigrationService_ListConversionWorkspaces_async
1921
2018
  */
1922
2019
  listConversionWorkspacesAsync(request?: protos.google.cloud.clouddms.v1.IListConversionWorkspacesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IConversionWorkspace>;
2020
+ /**
2021
+ * Lists the mapping rules for a specific conversion workspace.
2022
+ *
2023
+ * @param {Object} request
2024
+ * The request object that will be sent.
2025
+ * @param {string} request.parent
2026
+ * Required. Name of the conversion workspace resource whose mapping rules are
2027
+ * listed in the form of:
2028
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
2029
+ * @param {number} request.pageSize
2030
+ * The maximum number of rules to return. The service may return
2031
+ * fewer than this value.
2032
+ * @param {string} request.pageToken
2033
+ * The nextPageToken value received in the previous call to
2034
+ * mappingRules.list, used in the subsequent request to retrieve the next
2035
+ * page of results. On first call this should be left blank. When paginating,
2036
+ * all other parameters provided to mappingRules.list must match the call
2037
+ * that provided the page token.
2038
+ * @param {object} [options]
2039
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2040
+ * @returns {Promise} - The promise which resolves to an array.
2041
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}.
2042
+ * The client library will perform auto-pagination by default: it will call the API as many
2043
+ * times as needed and will merge results from all the pages into this array.
2044
+ * Note that it can affect your quota.
2045
+ * We recommend using `listMappingRulesAsync()`
2046
+ * method described below for async iteration which you can stop as needed.
2047
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2048
+ * for more details and examples.
2049
+ */
2050
+ listMappingRules(request?: protos.google.cloud.clouddms.v1.IListMappingRulesRequest, options?: CallOptions): Promise<[
2051
+ protos.google.cloud.clouddms.v1.IMappingRule[],
2052
+ protos.google.cloud.clouddms.v1.IListMappingRulesRequest | null,
2053
+ protos.google.cloud.clouddms.v1.IListMappingRulesResponse
2054
+ ]>;
2055
+ listMappingRules(request: protos.google.cloud.clouddms.v1.IListMappingRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMappingRulesRequest, protos.google.cloud.clouddms.v1.IListMappingRulesResponse | null | undefined, protos.google.cloud.clouddms.v1.IMappingRule>): void;
2056
+ listMappingRules(request: protos.google.cloud.clouddms.v1.IListMappingRulesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMappingRulesRequest, protos.google.cloud.clouddms.v1.IListMappingRulesResponse | null | undefined, protos.google.cloud.clouddms.v1.IMappingRule>): void;
2057
+ /**
2058
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
2059
+ * @param {Object} request
2060
+ * The request object that will be sent.
2061
+ * @param {string} request.parent
2062
+ * Required. Name of the conversion workspace resource whose mapping rules are
2063
+ * listed in the form of:
2064
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
2065
+ * @param {number} request.pageSize
2066
+ * The maximum number of rules to return. The service may return
2067
+ * fewer than this value.
2068
+ * @param {string} request.pageToken
2069
+ * The nextPageToken value received in the previous call to
2070
+ * mappingRules.list, used in the subsequent request to retrieve the next
2071
+ * page of results. On first call this should be left blank. When paginating,
2072
+ * all other parameters provided to mappingRules.list must match the call
2073
+ * that provided the page token.
2074
+ * @param {object} [options]
2075
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2076
+ * @returns {Stream}
2077
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule} on 'data' event.
2078
+ * The client library will perform auto-pagination by default: it will call the API as many
2079
+ * times as needed. Note that it can affect your quota.
2080
+ * We recommend using `listMappingRulesAsync()`
2081
+ * method described below for async iteration which you can stop as needed.
2082
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2083
+ * for more details and examples.
2084
+ */
2085
+ listMappingRulesStream(request?: protos.google.cloud.clouddms.v1.IListMappingRulesRequest, options?: CallOptions): Transform;
2086
+ /**
2087
+ * Equivalent to `listMappingRules`, but returns an iterable object.
2088
+ *
2089
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
2090
+ * @param {Object} request
2091
+ * The request object that will be sent.
2092
+ * @param {string} request.parent
2093
+ * Required. Name of the conversion workspace resource whose mapping rules are
2094
+ * listed in the form of:
2095
+ * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
2096
+ * @param {number} request.pageSize
2097
+ * The maximum number of rules to return. The service may return
2098
+ * fewer than this value.
2099
+ * @param {string} request.pageToken
2100
+ * The nextPageToken value received in the previous call to
2101
+ * mappingRules.list, used in the subsequent request to retrieve the next
2102
+ * page of results. On first call this should be left blank. When paginating,
2103
+ * all other parameters provided to mappingRules.list must match the call
2104
+ * that provided the page token.
2105
+ * @param {object} [options]
2106
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2107
+ * @returns {Object}
2108
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2109
+ * When you iterate the returned iterable, each element will be an object representing
2110
+ * {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}. The API will be called under the hood as needed, once per the page,
2111
+ * so you can stop the iteration when you don't need more results.
2112
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2113
+ * for more details and examples.
2114
+ * @example <caption>include:samples/generated/v1/data_migration_service.list_mapping_rules.js</caption>
2115
+ * region_tag:datamigration_v1_generated_DataMigrationService_ListMappingRules_async
2116
+ */
2117
+ listMappingRulesAsync(request?: protos.google.cloud.clouddms.v1.IListMappingRulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IMappingRule>;
1923
2118
  /**
1924
2119
  * Describes the database entities tree for a specific conversion workspace
1925
2120
  * and a specific tree type.
@@ -1934,37 +2129,39 @@ export declare class DataMigrationServiceClient {
1934
2129
  * Required. Name of the conversion workspace resource whose database entities
1935
2130
  * are described. Must be in the form of:
1936
2131
  * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1937
- * @param {number} request.pageSize
1938
- * The maximum number of entities to return. The service may return
2132
+ * @param {number} [request.pageSize]
2133
+ * Optional. The maximum number of entities to return. The service may return
1939
2134
  * fewer entities than the value specifies.
1940
- * @param {string} request.pageToken
1941
- * The nextPageToken value received in the previous call to
2135
+ * @param {string} [request.pageToken]
2136
+ * Optional. The nextPageToken value received in the previous call to
1942
2137
  * conversionWorkspace.describeDatabaseEntities, used in the subsequent
1943
2138
  * request to retrieve the next page of results. On first call this should be
1944
2139
  * left blank. When paginating, all other parameters provided to
1945
2140
  * conversionWorkspace.describeDatabaseEntities must match the call that
1946
2141
  * provided the page token.
1947
2142
  * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
1948
- * The tree to fetch.
1949
- * @param {boolean} request.uncommitted
1950
- * Whether to retrieve the latest committed version of the entities or the
1951
- * latest version. This field is ignored if a specific commit_id is specified.
1952
- * @param {string} request.commitId
1953
- * Request a specific commit ID. If not specified, the entities from the
1954
- * latest commit are returned.
1955
- * @param {string} request.filter
1956
- * Filter the returned entities based on AIP-160 standard.
2143
+ * Required. The tree to fetch.
2144
+ * @param {boolean} [request.uncommitted]
2145
+ * Optional. Whether to retrieve the latest committed version of the entities
2146
+ * or the latest version. This field is ignored if a specific commit_id is
2147
+ * specified.
2148
+ * @param {string} [request.commitId]
2149
+ * Optional. Request a specific commit ID. If not specified, the entities from
2150
+ * the latest commit are returned.
2151
+ * @param {string} [request.filter]
2152
+ * Optional. Filter the returned entities based on AIP-160 standard.
2153
+ * @param {google.cloud.clouddms.v1.DatabaseEntityView} [request.view]
2154
+ * Optional. Results view based on AIP-157
1957
2155
  * @param {object} [options]
1958
2156
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1959
2157
  * @returns {Promise} - The promise which resolves to an array.
1960
- * The first element of the array is Array of {@link google.cloud.clouddms.v1.DatabaseEntity | DatabaseEntity}.
2158
+ * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}.
1961
2159
  * The client library will perform auto-pagination by default: it will call the API as many
1962
2160
  * times as needed and will merge results from all the pages into this array.
1963
2161
  * Note that it can affect your quota.
1964
2162
  * We recommend using `describeDatabaseEntitiesAsync()`
1965
2163
  * method described below for async iteration which you can stop as needed.
1966
- * Please see the
1967
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2164
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1968
2165
  * for more details and examples.
1969
2166
  */
1970
2167
  describeDatabaseEntities(request?: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options?: CallOptions): Promise<[
@@ -1982,36 +2179,38 @@ export declare class DataMigrationServiceClient {
1982
2179
  * Required. Name of the conversion workspace resource whose database entities
1983
2180
  * are described. Must be in the form of:
1984
2181
  * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1985
- * @param {number} request.pageSize
1986
- * The maximum number of entities to return. The service may return
2182
+ * @param {number} [request.pageSize]
2183
+ * Optional. The maximum number of entities to return. The service may return
1987
2184
  * fewer entities than the value specifies.
1988
- * @param {string} request.pageToken
1989
- * The nextPageToken value received in the previous call to
2185
+ * @param {string} [request.pageToken]
2186
+ * Optional. The nextPageToken value received in the previous call to
1990
2187
  * conversionWorkspace.describeDatabaseEntities, used in the subsequent
1991
2188
  * request to retrieve the next page of results. On first call this should be
1992
2189
  * left blank. When paginating, all other parameters provided to
1993
2190
  * conversionWorkspace.describeDatabaseEntities must match the call that
1994
2191
  * provided the page token.
1995
2192
  * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
1996
- * The tree to fetch.
1997
- * @param {boolean} request.uncommitted
1998
- * Whether to retrieve the latest committed version of the entities or the
1999
- * latest version. This field is ignored if a specific commit_id is specified.
2000
- * @param {string} request.commitId
2001
- * Request a specific commit ID. If not specified, the entities from the
2002
- * latest commit are returned.
2003
- * @param {string} request.filter
2004
- * Filter the returned entities based on AIP-160 standard.
2193
+ * Required. The tree to fetch.
2194
+ * @param {boolean} [request.uncommitted]
2195
+ * Optional. Whether to retrieve the latest committed version of the entities
2196
+ * or the latest version. This field is ignored if a specific commit_id is
2197
+ * specified.
2198
+ * @param {string} [request.commitId]
2199
+ * Optional. Request a specific commit ID. If not specified, the entities from
2200
+ * the latest commit are returned.
2201
+ * @param {string} [request.filter]
2202
+ * Optional. Filter the returned entities based on AIP-160 standard.
2203
+ * @param {google.cloud.clouddms.v1.DatabaseEntityView} [request.view]
2204
+ * Optional. Results view based on AIP-157
2005
2205
  * @param {object} [options]
2006
2206
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2007
2207
  * @returns {Stream}
2008
- * An object stream which emits an object representing {@link google.cloud.clouddms.v1.DatabaseEntity | DatabaseEntity} on 'data' event.
2208
+ * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity} on 'data' event.
2009
2209
  * The client library will perform auto-pagination by default: it will call the API as many
2010
2210
  * times as needed. Note that it can affect your quota.
2011
2211
  * We recommend using `describeDatabaseEntitiesAsync()`
2012
2212
  * method described below for async iteration which you can stop as needed.
2013
- * Please see the
2014
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2213
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2015
2214
  * for more details and examples.
2016
2215
  */
2017
2216
  describeDatabaseEntitiesStream(request?: protos.google.cloud.clouddms.v1.IDescribeDatabaseEntitiesRequest, options?: CallOptions): Transform;
@@ -2025,35 +2224,37 @@ export declare class DataMigrationServiceClient {
2025
2224
  * Required. Name of the conversion workspace resource whose database entities
2026
2225
  * are described. Must be in the form of:
2027
2226
  * projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
2028
- * @param {number} request.pageSize
2029
- * The maximum number of entities to return. The service may return
2227
+ * @param {number} [request.pageSize]
2228
+ * Optional. The maximum number of entities to return. The service may return
2030
2229
  * fewer entities than the value specifies.
2031
- * @param {string} request.pageToken
2032
- * The nextPageToken value received in the previous call to
2230
+ * @param {string} [request.pageToken]
2231
+ * Optional. The nextPageToken value received in the previous call to
2033
2232
  * conversionWorkspace.describeDatabaseEntities, used in the subsequent
2034
2233
  * request to retrieve the next page of results. On first call this should be
2035
2234
  * left blank. When paginating, all other parameters provided to
2036
2235
  * conversionWorkspace.describeDatabaseEntities must match the call that
2037
2236
  * provided the page token.
2038
2237
  * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
2039
- * The tree to fetch.
2040
- * @param {boolean} request.uncommitted
2041
- * Whether to retrieve the latest committed version of the entities or the
2042
- * latest version. This field is ignored if a specific commit_id is specified.
2043
- * @param {string} request.commitId
2044
- * Request a specific commit ID. If not specified, the entities from the
2045
- * latest commit are returned.
2046
- * @param {string} request.filter
2047
- * Filter the returned entities based on AIP-160 standard.
2238
+ * Required. The tree to fetch.
2239
+ * @param {boolean} [request.uncommitted]
2240
+ * Optional. Whether to retrieve the latest committed version of the entities
2241
+ * or the latest version. This field is ignored if a specific commit_id is
2242
+ * specified.
2243
+ * @param {string} [request.commitId]
2244
+ * Optional. Request a specific commit ID. If not specified, the entities from
2245
+ * the latest commit are returned.
2246
+ * @param {string} [request.filter]
2247
+ * Optional. Filter the returned entities based on AIP-160 standard.
2248
+ * @param {google.cloud.clouddms.v1.DatabaseEntityView} [request.view]
2249
+ * Optional. Results view based on AIP-157
2048
2250
  * @param {object} [options]
2049
2251
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2050
2252
  * @returns {Object}
2051
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
2253
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2052
2254
  * When you iterate the returned iterable, each element will be an object representing
2053
- * {@link google.cloud.clouddms.v1.DatabaseEntity | DatabaseEntity}. The API will be called under the hood as needed, once per the page,
2255
+ * {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}. The API will be called under the hood as needed, once per the page,
2054
2256
  * so you can stop the iteration when you don't need more results.
2055
- * Please see the
2056
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2257
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2057
2258
  * for more details and examples.
2058
2259
  * @example <caption>include:samples/generated/v1/data_migration_service.describe_database_entities.js</caption>
2059
2260
  * region_tag:datamigration_v1_generated_DataMigrationService_DescribeDatabaseEntities_async
@@ -2081,8 +2282,7 @@ export declare class DataMigrationServiceClient {
2081
2282
  * Note that it can affect your quota.
2082
2283
  * We recommend using `fetchStaticIpsAsync()`
2083
2284
  * method described below for async iteration which you can stop as needed.
2084
- * Please see the
2085
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2285
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2086
2286
  * for more details and examples.
2087
2287
  */
2088
2288
  fetchStaticIps(request?: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options?: CallOptions): Promise<[
@@ -2111,8 +2311,7 @@ export declare class DataMigrationServiceClient {
2111
2311
  * times as needed. Note that it can affect your quota.
2112
2312
  * We recommend using `fetchStaticIpsAsync()`
2113
2313
  * method described below for async iteration which you can stop as needed.
2114
- * Please see the
2115
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2314
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2116
2315
  * for more details and examples.
2117
2316
  */
2118
2317
  fetchStaticIpsStream(request?: protos.google.cloud.clouddms.v1.IFetchStaticIpsRequest, options?: CallOptions): Transform;
@@ -2132,12 +2331,11 @@ export declare class DataMigrationServiceClient {
2132
2331
  * @param {object} [options]
2133
2332
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2134
2333
  * @returns {Object}
2135
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
2334
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2136
2335
  * When you iterate the returned iterable, each element will be an object representing
2137
2336
  * string. The API will be called under the hood as needed, once per the page,
2138
2337
  * so you can stop the iteration when you don't need more results.
2139
- * Please see the
2140
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2338
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2141
2339
  * for more details and examples.
2142
2340
  * @example <caption>include:samples/generated/v1/data_migration_service.fetch_static_ips.js</caption>
2143
2341
  * region_tag:datamigration_v1_generated_DataMigrationService_FetchStaticIps_async
@@ -2168,7 +2366,7 @@ export declare class DataMigrationServiceClient {
2168
2366
  * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}.
2169
2367
  * The promise has a method named "cancel" which cancels the ongoing API call.
2170
2368
  */
2171
- 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>;
2369
+ 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]>;
2172
2370
  /**
2173
2371
  * Returns permissions that a caller has on the specified resource. If the
2174
2372
  * resource does not exist, this will return an empty set of
@@ -2186,8 +2384,7 @@ export declare class DataMigrationServiceClient {
2186
2384
  * @param {string[]} request.permissions
2187
2385
  * The set of permissions to check for the `resource`. Permissions with
2188
2386
  * wildcards (such as '*' or 'storage.*') are not allowed. For more
2189
- * information see
2190
- * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
2387
+ * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }.
2191
2388
  * @param {Object} [options]
2192
2389
  * Optional parameters. You can override the default settings for this call, e.g, timeout,
2193
2390
  * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
@@ -2199,7 +2396,7 @@ export declare class DataMigrationServiceClient {
2199
2396
  * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}.
2200
2397
  * The promise has a method named "cancel" which cancels the ongoing API call.
2201
2398
  */
2202
- 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>;
2399
+ 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]>;
2203
2400
  /**
2204
2401
  * Returns permissions that a caller has on the specified resource. If the
2205
2402
  * resource does not exist, this will return an empty set of
@@ -2217,8 +2414,7 @@ export declare class DataMigrationServiceClient {
2217
2414
  * @param {string[]} request.permissions
2218
2415
  * The set of permissions to check for the `resource`. Permissions with
2219
2416
  * wildcards (such as '*' or 'storage.*') are not allowed. For more
2220
- * information see
2221
- * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
2417
+ * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }.
2222
2418
  * @param {Object} [options]
2223
2419
  * Optional parameters. You can override the default settings for this call, e.g, timeout,
2224
2420
  * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
@@ -2231,7 +2427,7 @@ export declare class DataMigrationServiceClient {
2231
2427
  * The promise has a method named "cancel" which cancels the ongoing API call.
2232
2428
  *
2233
2429
  */
2234
- 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>;
2430
+ 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]>;
2235
2431
  /**
2236
2432
  * Gets information about a location.
2237
2433
  *
@@ -2243,8 +2439,7 @@ export declare class DataMigrationServiceClient {
2243
2439
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
2244
2440
  * @returns {Promise} - The promise which resolves to an array.
2245
2441
  * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
2246
- * Please see the
2247
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
2442
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
2248
2443
  * for more details and examples.
2249
2444
  * @example
2250
2445
  * ```
@@ -2269,12 +2464,11 @@ export declare class DataMigrationServiceClient {
2269
2464
  * @param {object} [options]
2270
2465
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2271
2466
  * @returns {Object}
2272
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
2467
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
2273
2468
  * When you iterate the returned iterable, each element will be an object representing
2274
2469
  * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
2275
2470
  * so you can stop the iteration when you don't need more results.
2276
- * Please see the
2277
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
2471
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
2278
2472
  * for more details and examples.
2279
2473
  * @example
2280
2474
  * ```
@@ -2495,6 +2689,48 @@ export declare class DataMigrationServiceClient {
2495
2689
  * @returns {string} A string representing the location.
2496
2690
  */
2497
2691
  matchLocationFromLocationName(locationName: string): string | number;
2692
+ /**
2693
+ * Return a fully-qualified mappingRule resource name string.
2694
+ *
2695
+ * @param {string} project
2696
+ * @param {string} location
2697
+ * @param {string} conversion_workspace
2698
+ * @param {string} mapping_rule
2699
+ * @returns {string} Resource name string.
2700
+ */
2701
+ mappingRulePath(project: string, location: string, conversionWorkspace: string, mappingRule: string): string;
2702
+ /**
2703
+ * Parse the project from MappingRule resource.
2704
+ *
2705
+ * @param {string} mappingRuleName
2706
+ * A fully-qualified path representing MappingRule resource.
2707
+ * @returns {string} A string representing the project.
2708
+ */
2709
+ matchProjectFromMappingRuleName(mappingRuleName: string): string | number;
2710
+ /**
2711
+ * Parse the location from MappingRule resource.
2712
+ *
2713
+ * @param {string} mappingRuleName
2714
+ * A fully-qualified path representing MappingRule resource.
2715
+ * @returns {string} A string representing the location.
2716
+ */
2717
+ matchLocationFromMappingRuleName(mappingRuleName: string): string | number;
2718
+ /**
2719
+ * Parse the conversion_workspace from MappingRule resource.
2720
+ *
2721
+ * @param {string} mappingRuleName
2722
+ * A fully-qualified path representing MappingRule resource.
2723
+ * @returns {string} A string representing the conversion_workspace.
2724
+ */
2725
+ matchConversionWorkspaceFromMappingRuleName(mappingRuleName: string): string | number;
2726
+ /**
2727
+ * Parse the mapping_rule from MappingRule resource.
2728
+ *
2729
+ * @param {string} mappingRuleName
2730
+ * A fully-qualified path representing MappingRule resource.
2731
+ * @returns {string} A string representing the mapping_rule.
2732
+ */
2733
+ matchMappingRuleFromMappingRuleName(mappingRuleName: string): string | number;
2498
2734
  /**
2499
2735
  * Return a fully-qualified migrationJob resource name string.
2500
2736
  *