@google-cloud/dms 1.0.4 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/README.md +17 -17
- package/build/protos/google/cloud/clouddms/v1/clouddms_resources.proto +1 -1
- package/build/protos/protos.d.ts +31 -24
- package/build/protos/protos.js +52 -23
- package/build/protos/protos.json +21 -1
- package/build/src/v1/data_migration_service_client.d.ts +566 -87
- package/build/src/v1/data_migration_service_client.js +43 -544
- package/build/src/v1/data_migration_service_client.js.map +1 -1
- package/build/src/v1/index.js +2 -1
- package/build/src/v1/index.js.map +1 -1
- package/package.json +9 -9
|
@@ -102,16 +102,125 @@ export declare class DataMigrationServiceClient {
|
|
|
102
102
|
static get scopes(): string[];
|
|
103
103
|
getProjectId(): Promise<string>;
|
|
104
104
|
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
105
|
-
|
|
105
|
+
/**
|
|
106
|
+
* Gets details of a single migration job.
|
|
107
|
+
*
|
|
108
|
+
* @param {Object} request
|
|
109
|
+
* The request object that will be sent.
|
|
110
|
+
* @param {string} request.name
|
|
111
|
+
* Required. Name of the migration job resource to get.
|
|
112
|
+
* @param {object} [options]
|
|
113
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
114
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
115
|
+
* The first element of the array is an object representing [MigrationJob]{@link google.cloud.clouddms.v1.MigrationJob}.
|
|
116
|
+
* Please see the
|
|
117
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
118
|
+
* for more details and examples.
|
|
119
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.get_migration_job.js</caption>
|
|
120
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_GetMigrationJob_async
|
|
121
|
+
*/
|
|
122
|
+
getMigrationJob(request?: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, options?: CallOptions): Promise<[
|
|
123
|
+
protos.google.cloud.clouddms.v1.IMigrationJob,
|
|
124
|
+
protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | undefined,
|
|
125
|
+
{} | undefined
|
|
126
|
+
]>;
|
|
106
127
|
getMigrationJob(request: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | null | undefined, {} | null | undefined>): void;
|
|
107
128
|
getMigrationJob(request: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | null | undefined, {} | null | undefined>): void;
|
|
108
|
-
|
|
129
|
+
/**
|
|
130
|
+
* Generate a SSH configuration script to configure the reverse SSH
|
|
131
|
+
* connectivity.
|
|
132
|
+
*
|
|
133
|
+
* @param {Object} request
|
|
134
|
+
* The request object that will be sent.
|
|
135
|
+
* @param {string} request.migrationJob
|
|
136
|
+
* Name of the migration job resource to generate the SSH script.
|
|
137
|
+
* @param {string} request.vm
|
|
138
|
+
* Required. Bastion VM Instance name to use or to create.
|
|
139
|
+
* @param {google.cloud.clouddms.v1.VmCreationConfig} request.vmCreationConfig
|
|
140
|
+
* The VM creation configuration
|
|
141
|
+
* @param {google.cloud.clouddms.v1.VmSelectionConfig} request.vmSelectionConfig
|
|
142
|
+
* The VM selection configuration
|
|
143
|
+
* @param {number} request.vmPort
|
|
144
|
+
* The port that will be open on the bastion host
|
|
145
|
+
* @param {object} [options]
|
|
146
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
147
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
148
|
+
* The first element of the array is an object representing [SshScript]{@link google.cloud.clouddms.v1.SshScript}.
|
|
149
|
+
* Please see the
|
|
150
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
151
|
+
* for more details and examples.
|
|
152
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.generate_ssh_script.js</caption>
|
|
153
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_GenerateSshScript_async
|
|
154
|
+
*/
|
|
155
|
+
generateSshScript(request?: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, options?: CallOptions): Promise<[
|
|
156
|
+
protos.google.cloud.clouddms.v1.ISshScript,
|
|
157
|
+
protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | undefined,
|
|
158
|
+
{} | undefined
|
|
159
|
+
]>;
|
|
109
160
|
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;
|
|
110
161
|
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;
|
|
111
|
-
|
|
162
|
+
/**
|
|
163
|
+
* Gets details of a single connection profile.
|
|
164
|
+
*
|
|
165
|
+
* @param {Object} request
|
|
166
|
+
* The request object that will be sent.
|
|
167
|
+
* @param {string} request.name
|
|
168
|
+
* Required. Name of the connection profile resource to get.
|
|
169
|
+
* @param {object} [options]
|
|
170
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
171
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
172
|
+
* The first element of the array is an object representing [ConnectionProfile]{@link google.cloud.clouddms.v1.ConnectionProfile}.
|
|
173
|
+
* Please see the
|
|
174
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
175
|
+
* for more details and examples.
|
|
176
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.get_connection_profile.js</caption>
|
|
177
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async
|
|
178
|
+
*/
|
|
179
|
+
getConnectionProfile(request?: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, options?: CallOptions): Promise<[
|
|
180
|
+
protos.google.cloud.clouddms.v1.IConnectionProfile,
|
|
181
|
+
protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | undefined,
|
|
182
|
+
{} | undefined
|
|
183
|
+
]>;
|
|
112
184
|
getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
|
|
113
185
|
getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
|
|
114
|
-
|
|
186
|
+
/**
|
|
187
|
+
* Creates a new migration job in a given project and location.
|
|
188
|
+
*
|
|
189
|
+
* @param {Object} request
|
|
190
|
+
* The request object that will be sent.
|
|
191
|
+
* @param {string} request.parent
|
|
192
|
+
* Required. The parent, which owns this collection of migration jobs.
|
|
193
|
+
* @param {string} request.migrationJobId
|
|
194
|
+
* Required. The ID of the instance to create.
|
|
195
|
+
* @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
|
|
196
|
+
* Required. Represents a [migration
|
|
197
|
+
* job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
|
|
198
|
+
* object.
|
|
199
|
+
* @param {string} request.requestId
|
|
200
|
+
* A unique id used to identify the request. If the server receives two
|
|
201
|
+
* requests with the same id, then the second request will be ignored.
|
|
202
|
+
*
|
|
203
|
+
* It is recommended to always set this value to a UUID.
|
|
204
|
+
*
|
|
205
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
206
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
207
|
+
* @param {object} [options]
|
|
208
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
209
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
210
|
+
* The first element of the array is an object representing
|
|
211
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
212
|
+
* you can `await` for.
|
|
213
|
+
* Please see the
|
|
214
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
215
|
+
* for more details and examples.
|
|
216
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
|
|
217
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
|
|
218
|
+
*/
|
|
219
|
+
createMigrationJob(request?: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, options?: CallOptions): Promise<[
|
|
220
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
221
|
+
protos.google.longrunning.IOperation | undefined,
|
|
222
|
+
{} | undefined
|
|
223
|
+
]>;
|
|
115
224
|
createMigrationJob(request: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
116
225
|
createMigrationJob(request: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
117
226
|
/**
|
|
@@ -123,14 +232,45 @@ export declare class DataMigrationServiceClient {
|
|
|
123
232
|
* Please see the
|
|
124
233
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
125
234
|
* for more details and examples.
|
|
126
|
-
* @example
|
|
127
|
-
*
|
|
128
|
-
* console.log(decodedOperation.result);
|
|
129
|
-
* console.log(decodedOperation.done);
|
|
130
|
-
* console.log(decodedOperation.metadata);
|
|
235
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
|
|
236
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
|
|
131
237
|
*/
|
|
132
238
|
checkCreateMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
133
|
-
|
|
239
|
+
/**
|
|
240
|
+
* Updates the parameters of a single migration job.
|
|
241
|
+
*
|
|
242
|
+
* @param {Object} request
|
|
243
|
+
* The request object that will be sent.
|
|
244
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
245
|
+
* Required. Field mask is used to specify the fields to be overwritten in the
|
|
246
|
+
* migration job resource by the update.
|
|
247
|
+
* @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
|
|
248
|
+
* Required. The migration job parameters to update.
|
|
249
|
+
* @param {string} request.requestId
|
|
250
|
+
* A unique id used to identify the request. If the server receives two
|
|
251
|
+
* requests with the same id, then the second request will be ignored.
|
|
252
|
+
*
|
|
253
|
+
* It is recommended to always set this value to a UUID.
|
|
254
|
+
*
|
|
255
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
256
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
257
|
+
* @param {object} [options]
|
|
258
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
259
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
260
|
+
* The first element of the array is an object representing
|
|
261
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
262
|
+
* you can `await` for.
|
|
263
|
+
* Please see the
|
|
264
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
265
|
+
* for more details and examples.
|
|
266
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
|
|
267
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
|
|
268
|
+
*/
|
|
269
|
+
updateMigrationJob(request?: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, options?: CallOptions): Promise<[
|
|
270
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
271
|
+
protos.google.longrunning.IOperation | undefined,
|
|
272
|
+
{} | undefined
|
|
273
|
+
]>;
|
|
134
274
|
updateMigrationJob(request: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
135
275
|
updateMigrationJob(request: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
136
276
|
/**
|
|
@@ -142,14 +282,46 @@ export declare class DataMigrationServiceClient {
|
|
|
142
282
|
* Please see the
|
|
143
283
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
144
284
|
* for more details and examples.
|
|
145
|
-
* @example
|
|
146
|
-
*
|
|
147
|
-
* console.log(decodedOperation.result);
|
|
148
|
-
* console.log(decodedOperation.done);
|
|
149
|
-
* console.log(decodedOperation.metadata);
|
|
285
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
|
|
286
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
|
|
150
287
|
*/
|
|
151
288
|
checkUpdateMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
152
|
-
|
|
289
|
+
/**
|
|
290
|
+
* Deletes a single migration job.
|
|
291
|
+
*
|
|
292
|
+
* @param {Object} request
|
|
293
|
+
* The request object that will be sent.
|
|
294
|
+
* @param {string} request.name
|
|
295
|
+
* Required. Name of the migration job resource to delete.
|
|
296
|
+
* @param {string} request.requestId
|
|
297
|
+
* A unique id used to identify the request. If the server receives two
|
|
298
|
+
* requests with the same id, then the second request will be ignored.
|
|
299
|
+
*
|
|
300
|
+
* It is recommended to always set this value to a UUID.
|
|
301
|
+
*
|
|
302
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
303
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
304
|
+
* @param {boolean} request.force
|
|
305
|
+
* The destination CloudSQL connection profile is always deleted with the
|
|
306
|
+
* migration job. In case of force delete, the destination CloudSQL replica
|
|
307
|
+
* database is also deleted.
|
|
308
|
+
* @param {object} [options]
|
|
309
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
310
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
311
|
+
* The first element of the array is an object representing
|
|
312
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
313
|
+
* you can `await` for.
|
|
314
|
+
* Please see the
|
|
315
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
316
|
+
* for more details and examples.
|
|
317
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
|
|
318
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
|
|
319
|
+
*/
|
|
320
|
+
deleteMigrationJob(request?: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, options?: CallOptions): Promise<[
|
|
321
|
+
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
322
|
+
protos.google.longrunning.IOperation | undefined,
|
|
323
|
+
{} | undefined
|
|
324
|
+
]>;
|
|
153
325
|
deleteMigrationJob(request: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
154
326
|
deleteMigrationJob(request: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
155
327
|
/**
|
|
@@ -161,14 +333,34 @@ export declare class DataMigrationServiceClient {
|
|
|
161
333
|
* Please see the
|
|
162
334
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
163
335
|
* for more details and examples.
|
|
164
|
-
* @example
|
|
165
|
-
*
|
|
166
|
-
* console.log(decodedOperation.result);
|
|
167
|
-
* console.log(decodedOperation.done);
|
|
168
|
-
* console.log(decodedOperation.metadata);
|
|
336
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
|
|
337
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
|
|
169
338
|
*/
|
|
170
339
|
checkDeleteMigrationJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
171
|
-
|
|
340
|
+
/**
|
|
341
|
+
* Start an already created migration job.
|
|
342
|
+
*
|
|
343
|
+
* @param {Object} request
|
|
344
|
+
* The request object that will be sent.
|
|
345
|
+
* @param {string} request.name
|
|
346
|
+
* Name of the migration job resource to start.
|
|
347
|
+
* @param {object} [options]
|
|
348
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
349
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
350
|
+
* The first element of the array is an object representing
|
|
351
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
352
|
+
* you can `await` for.
|
|
353
|
+
* Please see the
|
|
354
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
355
|
+
* for more details and examples.
|
|
356
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
|
|
357
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
|
|
358
|
+
*/
|
|
359
|
+
startMigrationJob(request?: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, options?: CallOptions): Promise<[
|
|
360
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
361
|
+
protos.google.longrunning.IOperation | undefined,
|
|
362
|
+
{} | undefined
|
|
363
|
+
]>;
|
|
172
364
|
startMigrationJob(request: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
173
365
|
startMigrationJob(request: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
174
366
|
/**
|
|
@@ -180,14 +372,34 @@ export declare class DataMigrationServiceClient {
|
|
|
180
372
|
* Please see the
|
|
181
373
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
182
374
|
* for more details and examples.
|
|
183
|
-
* @example
|
|
184
|
-
*
|
|
185
|
-
* console.log(decodedOperation.result);
|
|
186
|
-
* console.log(decodedOperation.done);
|
|
187
|
-
* console.log(decodedOperation.metadata);
|
|
375
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
|
|
376
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
|
|
188
377
|
*/
|
|
189
378
|
checkStartMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
190
|
-
|
|
379
|
+
/**
|
|
380
|
+
* Stops a running migration job.
|
|
381
|
+
*
|
|
382
|
+
* @param {Object} request
|
|
383
|
+
* The request object that will be sent.
|
|
384
|
+
* @param {string} request.name
|
|
385
|
+
* Name of the migration job resource to stop.
|
|
386
|
+
* @param {object} [options]
|
|
387
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
388
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
389
|
+
* The first element of the array is an object representing
|
|
390
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
391
|
+
* you can `await` for.
|
|
392
|
+
* Please see the
|
|
393
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
394
|
+
* for more details and examples.
|
|
395
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
|
|
396
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
|
|
397
|
+
*/
|
|
398
|
+
stopMigrationJob(request?: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, options?: CallOptions): Promise<[
|
|
399
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
400
|
+
protos.google.longrunning.IOperation | undefined,
|
|
401
|
+
{} | undefined
|
|
402
|
+
]>;
|
|
191
403
|
stopMigrationJob(request: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
192
404
|
stopMigrationJob(request: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
193
405
|
/**
|
|
@@ -199,14 +411,35 @@ export declare class DataMigrationServiceClient {
|
|
|
199
411
|
* Please see the
|
|
200
412
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
201
413
|
* for more details and examples.
|
|
202
|
-
* @example
|
|
203
|
-
*
|
|
204
|
-
* console.log(decodedOperation.result);
|
|
205
|
-
* console.log(decodedOperation.done);
|
|
206
|
-
* console.log(decodedOperation.metadata);
|
|
414
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
|
|
415
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
|
|
207
416
|
*/
|
|
208
417
|
checkStopMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
209
|
-
|
|
418
|
+
/**
|
|
419
|
+
* Resume a migration job that is currently stopped and is resumable (was
|
|
420
|
+
* stopped during CDC phase).
|
|
421
|
+
*
|
|
422
|
+
* @param {Object} request
|
|
423
|
+
* The request object that will be sent.
|
|
424
|
+
* @param {string} request.name
|
|
425
|
+
* Name of the migration job resource to resume.
|
|
426
|
+
* @param {object} [options]
|
|
427
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
428
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
429
|
+
* The first element of the array is an object representing
|
|
430
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
431
|
+
* you can `await` for.
|
|
432
|
+
* Please see the
|
|
433
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
434
|
+
* for more details and examples.
|
|
435
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
|
|
436
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
|
|
437
|
+
*/
|
|
438
|
+
resumeMigrationJob(request?: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, options?: CallOptions): Promise<[
|
|
439
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
440
|
+
protos.google.longrunning.IOperation | undefined,
|
|
441
|
+
{} | undefined
|
|
442
|
+
]>;
|
|
210
443
|
resumeMigrationJob(request: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
211
444
|
resumeMigrationJob(request: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
212
445
|
/**
|
|
@@ -218,14 +451,35 @@ export declare class DataMigrationServiceClient {
|
|
|
218
451
|
* Please see the
|
|
219
452
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
220
453
|
* for more details and examples.
|
|
221
|
-
* @example
|
|
222
|
-
*
|
|
223
|
-
* console.log(decodedOperation.result);
|
|
224
|
-
* console.log(decodedOperation.done);
|
|
225
|
-
* console.log(decodedOperation.metadata);
|
|
454
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
|
|
455
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
|
|
226
456
|
*/
|
|
227
457
|
checkResumeMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
228
|
-
|
|
458
|
+
/**
|
|
459
|
+
* Promote a migration job, stopping replication to the destination and
|
|
460
|
+
* promoting the destination to be a standalone database.
|
|
461
|
+
*
|
|
462
|
+
* @param {Object} request
|
|
463
|
+
* The request object that will be sent.
|
|
464
|
+
* @param {string} request.name
|
|
465
|
+
* Name of the migration job resource to promote.
|
|
466
|
+
* @param {object} [options]
|
|
467
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
468
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
469
|
+
* The first element of the array is an object representing
|
|
470
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
471
|
+
* you can `await` for.
|
|
472
|
+
* Please see the
|
|
473
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
474
|
+
* for more details and examples.
|
|
475
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
|
|
476
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
|
|
477
|
+
*/
|
|
478
|
+
promoteMigrationJob(request?: protos.google.cloud.clouddms.v1.IPromoteMigrationJobRequest, options?: CallOptions): Promise<[
|
|
479
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
480
|
+
protos.google.longrunning.IOperation | undefined,
|
|
481
|
+
{} | undefined
|
|
482
|
+
]>;
|
|
229
483
|
promoteMigrationJob(request: protos.google.cloud.clouddms.v1.IPromoteMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
230
484
|
promoteMigrationJob(request: protos.google.cloud.clouddms.v1.IPromoteMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
231
485
|
/**
|
|
@@ -237,14 +491,35 @@ export declare class DataMigrationServiceClient {
|
|
|
237
491
|
* Please see the
|
|
238
492
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
239
493
|
* for more details and examples.
|
|
240
|
-
* @example
|
|
241
|
-
*
|
|
242
|
-
* console.log(decodedOperation.result);
|
|
243
|
-
* console.log(decodedOperation.done);
|
|
244
|
-
* console.log(decodedOperation.metadata);
|
|
494
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.promote_migration_job.js</caption>
|
|
495
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async
|
|
245
496
|
*/
|
|
246
497
|
checkPromoteMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
247
|
-
|
|
498
|
+
/**
|
|
499
|
+
* Verify a migration job, making sure the destination can reach the source
|
|
500
|
+
* and that all configuration and prerequisites are met.
|
|
501
|
+
*
|
|
502
|
+
* @param {Object} request
|
|
503
|
+
* The request object that will be sent.
|
|
504
|
+
* @param {string} request.name
|
|
505
|
+
* Name of the migration job resource to verify.
|
|
506
|
+
* @param {object} [options]
|
|
507
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
508
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
509
|
+
* The first element of the array is an object representing
|
|
510
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
511
|
+
* you can `await` for.
|
|
512
|
+
* Please see the
|
|
513
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
514
|
+
* for more details and examples.
|
|
515
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
|
|
516
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
|
|
517
|
+
*/
|
|
518
|
+
verifyMigrationJob(request?: protos.google.cloud.clouddms.v1.IVerifyMigrationJobRequest, options?: CallOptions): Promise<[
|
|
519
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
520
|
+
protos.google.longrunning.IOperation | undefined,
|
|
521
|
+
{} | undefined
|
|
522
|
+
]>;
|
|
248
523
|
verifyMigrationJob(request: protos.google.cloud.clouddms.v1.IVerifyMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
249
524
|
verifyMigrationJob(request: protos.google.cloud.clouddms.v1.IVerifyMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
250
525
|
/**
|
|
@@ -256,14 +531,36 @@ export declare class DataMigrationServiceClient {
|
|
|
256
531
|
* Please see the
|
|
257
532
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
258
533
|
* for more details and examples.
|
|
259
|
-
* @example
|
|
260
|
-
*
|
|
261
|
-
* console.log(decodedOperation.result);
|
|
262
|
-
* console.log(decodedOperation.done);
|
|
263
|
-
* console.log(decodedOperation.metadata);
|
|
534
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.verify_migration_job.js</caption>
|
|
535
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async
|
|
264
536
|
*/
|
|
265
537
|
checkVerifyMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
266
|
-
|
|
538
|
+
/**
|
|
539
|
+
* Restart a stopped or failed migration job, resetting the destination
|
|
540
|
+
* instance to its original state and starting the migration process from
|
|
541
|
+
* scratch.
|
|
542
|
+
*
|
|
543
|
+
* @param {Object} request
|
|
544
|
+
* The request object that will be sent.
|
|
545
|
+
* @param {string} request.name
|
|
546
|
+
* Name of the migration job resource to restart.
|
|
547
|
+
* @param {object} [options]
|
|
548
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
549
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
550
|
+
* The first element of the array is an object representing
|
|
551
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
552
|
+
* you can `await` for.
|
|
553
|
+
* Please see the
|
|
554
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
555
|
+
* for more details and examples.
|
|
556
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
|
|
557
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
|
|
558
|
+
*/
|
|
559
|
+
restartMigrationJob(request?: protos.google.cloud.clouddms.v1.IRestartMigrationJobRequest, options?: CallOptions): Promise<[
|
|
560
|
+
LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
561
|
+
protos.google.longrunning.IOperation | undefined,
|
|
562
|
+
{} | undefined
|
|
563
|
+
]>;
|
|
267
564
|
restartMigrationJob(request: protos.google.cloud.clouddms.v1.IRestartMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
268
565
|
restartMigrationJob(request: protos.google.cloud.clouddms.v1.IRestartMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
269
566
|
/**
|
|
@@ -275,14 +572,46 @@ export declare class DataMigrationServiceClient {
|
|
|
275
572
|
* Please see the
|
|
276
573
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
277
574
|
* for more details and examples.
|
|
278
|
-
* @example
|
|
279
|
-
*
|
|
280
|
-
* console.log(decodedOperation.result);
|
|
281
|
-
* console.log(decodedOperation.done);
|
|
282
|
-
* console.log(decodedOperation.metadata);
|
|
575
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.restart_migration_job.js</caption>
|
|
576
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async
|
|
283
577
|
*/
|
|
284
578
|
checkRestartMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
285
|
-
|
|
579
|
+
/**
|
|
580
|
+
* Creates a new connection profile in a given project and location.
|
|
581
|
+
*
|
|
582
|
+
* @param {Object} request
|
|
583
|
+
* The request object that will be sent.
|
|
584
|
+
* @param {string} request.parent
|
|
585
|
+
* Required. The parent, which owns this collection of connection profiles.
|
|
586
|
+
* @param {string} request.connectionProfileId
|
|
587
|
+
* Required. The connection profile identifier.
|
|
588
|
+
* @param {google.cloud.clouddms.v1.ConnectionProfile} request.connectionProfile
|
|
589
|
+
* Required. The create request body including the connection profile data
|
|
590
|
+
* @param {string} request.requestId
|
|
591
|
+
* A unique id used to identify the request. If the server receives two
|
|
592
|
+
* requests with the same id, then the second request will be ignored.
|
|
593
|
+
*
|
|
594
|
+
* It is recommended to always set this value to a UUID.
|
|
595
|
+
*
|
|
596
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
597
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
598
|
+
* @param {object} [options]
|
|
599
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
600
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
601
|
+
* The first element of the array is an object representing
|
|
602
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
603
|
+
* you can `await` for.
|
|
604
|
+
* Please see the
|
|
605
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
606
|
+
* for more details and examples.
|
|
607
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
|
|
608
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
|
|
609
|
+
*/
|
|
610
|
+
createConnectionProfile(request?: protos.google.cloud.clouddms.v1.ICreateConnectionProfileRequest, options?: CallOptions): Promise<[
|
|
611
|
+
LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
612
|
+
protos.google.longrunning.IOperation | undefined,
|
|
613
|
+
{} | undefined
|
|
614
|
+
]>;
|
|
286
615
|
createConnectionProfile(request: protos.google.cloud.clouddms.v1.ICreateConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
287
616
|
createConnectionProfile(request: protos.google.cloud.clouddms.v1.ICreateConnectionProfileRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
288
617
|
/**
|
|
@@ -294,14 +623,45 @@ export declare class DataMigrationServiceClient {
|
|
|
294
623
|
* Please see the
|
|
295
624
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
296
625
|
* for more details and examples.
|
|
297
|
-
* @example
|
|
298
|
-
*
|
|
299
|
-
* console.log(decodedOperation.result);
|
|
300
|
-
* console.log(decodedOperation.done);
|
|
301
|
-
* console.log(decodedOperation.metadata);
|
|
626
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.create_connection_profile.js</caption>
|
|
627
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async
|
|
302
628
|
*/
|
|
303
629
|
checkCreateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConnectionProfile, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
304
|
-
|
|
630
|
+
/**
|
|
631
|
+
* Update the configuration of a single connection profile.
|
|
632
|
+
*
|
|
633
|
+
* @param {Object} request
|
|
634
|
+
* The request object that will be sent.
|
|
635
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
636
|
+
* Required. Field mask is used to specify the fields to be overwritten in the
|
|
637
|
+
* connection profile resource by the update.
|
|
638
|
+
* @param {google.cloud.clouddms.v1.ConnectionProfile} request.connectionProfile
|
|
639
|
+
* Required. The connection profile parameters to update.
|
|
640
|
+
* @param {string} request.requestId
|
|
641
|
+
* A unique id used to identify the request. If the server receives two
|
|
642
|
+
* requests with the same id, then the second request will be ignored.
|
|
643
|
+
*
|
|
644
|
+
* It is recommended to always set this value to a UUID.
|
|
645
|
+
*
|
|
646
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
647
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
648
|
+
* @param {object} [options]
|
|
649
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
650
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
651
|
+
* The first element of the array is an object representing
|
|
652
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
653
|
+
* you can `await` for.
|
|
654
|
+
* Please see the
|
|
655
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
656
|
+
* for more details and examples.
|
|
657
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
|
|
658
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
|
|
659
|
+
*/
|
|
660
|
+
updateConnectionProfile(request?: protos.google.cloud.clouddms.v1.IUpdateConnectionProfileRequest, options?: CallOptions): Promise<[
|
|
661
|
+
LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
662
|
+
protos.google.longrunning.IOperation | undefined,
|
|
663
|
+
{} | undefined
|
|
664
|
+
]>;
|
|
305
665
|
updateConnectionProfile(request: protos.google.cloud.clouddms.v1.IUpdateConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
306
666
|
updateConnectionProfile(request: protos.google.cloud.clouddms.v1.IUpdateConnectionProfileRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
307
667
|
/**
|
|
@@ -313,14 +673,47 @@ export declare class DataMigrationServiceClient {
|
|
|
313
673
|
* Please see the
|
|
314
674
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
315
675
|
* for more details and examples.
|
|
316
|
-
* @example
|
|
317
|
-
*
|
|
318
|
-
* console.log(decodedOperation.result);
|
|
319
|
-
* console.log(decodedOperation.done);
|
|
320
|
-
* console.log(decodedOperation.metadata);
|
|
676
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.update_connection_profile.js</caption>
|
|
677
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async
|
|
321
678
|
*/
|
|
322
679
|
checkUpdateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.ConnectionProfile, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
323
|
-
|
|
680
|
+
/**
|
|
681
|
+
* Deletes a single Database Migration Service connection profile.
|
|
682
|
+
* A connection profile can only be deleted if it is not in use by any
|
|
683
|
+
* active migration jobs.
|
|
684
|
+
*
|
|
685
|
+
* @param {Object} request
|
|
686
|
+
* The request object that will be sent.
|
|
687
|
+
* @param {string} request.name
|
|
688
|
+
* Required. Name of the connection profile resource to delete.
|
|
689
|
+
* @param {string} request.requestId
|
|
690
|
+
* A unique id used to identify the request. If the server receives two
|
|
691
|
+
* requests with the same id, then the second request will be ignored.
|
|
692
|
+
*
|
|
693
|
+
* It is recommended to always set this value to a UUID.
|
|
694
|
+
*
|
|
695
|
+
* The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
|
|
696
|
+
* (_), and hyphens (-). The maximum length is 40 characters.
|
|
697
|
+
* @param {boolean} request.force
|
|
698
|
+
* In case of force delete, the CloudSQL replica database is also deleted
|
|
699
|
+
* (only for CloudSQL connection profile).
|
|
700
|
+
* @param {object} [options]
|
|
701
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
702
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
703
|
+
* The first element of the array is an object representing
|
|
704
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
705
|
+
* you can `await` for.
|
|
706
|
+
* Please see the
|
|
707
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
708
|
+
* for more details and examples.
|
|
709
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
|
|
710
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
|
|
711
|
+
*/
|
|
712
|
+
deleteConnectionProfile(request?: protos.google.cloud.clouddms.v1.IDeleteConnectionProfileRequest, options?: CallOptions): Promise<[
|
|
713
|
+
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>,
|
|
714
|
+
protos.google.longrunning.IOperation | undefined,
|
|
715
|
+
{} | undefined
|
|
716
|
+
]>;
|
|
324
717
|
deleteConnectionProfile(request: protos.google.cloud.clouddms.v1.IDeleteConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
325
718
|
deleteConnectionProfile(request: protos.google.cloud.clouddms.v1.IDeleteConnectionProfileRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
326
719
|
/**
|
|
@@ -332,14 +725,59 @@ export declare class DataMigrationServiceClient {
|
|
|
332
725
|
* Please see the
|
|
333
726
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
|
334
727
|
* for more details and examples.
|
|
335
|
-
* @example
|
|
336
|
-
*
|
|
337
|
-
* console.log(decodedOperation.result);
|
|
338
|
-
* console.log(decodedOperation.done);
|
|
339
|
-
* console.log(decodedOperation.metadata);
|
|
728
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.delete_connection_profile.js</caption>
|
|
729
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async
|
|
340
730
|
*/
|
|
341
731
|
checkDeleteConnectionProfileProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
|
|
342
|
-
|
|
732
|
+
/**
|
|
733
|
+
* Lists migration jobs in a given project and location.
|
|
734
|
+
*
|
|
735
|
+
* @param {Object} request
|
|
736
|
+
* The request object that will be sent.
|
|
737
|
+
* @param {string} request.parent
|
|
738
|
+
* Required. The parent, which owns this collection of migrationJobs.
|
|
739
|
+
* @param {number} request.pageSize
|
|
740
|
+
* The maximum number of migration jobs to return. The service may return
|
|
741
|
+
* fewer than this value. If unspecified, at most 50 migration jobs will be
|
|
742
|
+
* returned. The maximum value is 1000; values above 1000 will be coerced to
|
|
743
|
+
* 1000.
|
|
744
|
+
* @param {string} request.pageToken
|
|
745
|
+
* The nextPageToken value received in the previous call to
|
|
746
|
+
* migrationJobs.list, used in the subsequent request to retrieve the next
|
|
747
|
+
* page of results. On first call this should be left blank. When paginating,
|
|
748
|
+
* all other parameters provided to migrationJobs.list must match the call
|
|
749
|
+
* that provided the page token.
|
|
750
|
+
* @param {string} request.filter
|
|
751
|
+
* A filter expression that filters migration jobs listed in the response.
|
|
752
|
+
* The expression must specify the field name, a comparison operator, and the
|
|
753
|
+
* value that you want to use for filtering. The value must be a string,
|
|
754
|
+
* a number, or a boolean. The comparison operator must be
|
|
755
|
+
* either =, !=, >, or <. For example, list migration jobs created this year
|
|
756
|
+
* by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
|
|
757
|
+
* You can also filter nested fields. For example, you could specify
|
|
758
|
+
* **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
|
|
759
|
+
* jobs connecting through the specific SSH tunnel bastion.
|
|
760
|
+
* @param {string} request.orderBy
|
|
761
|
+
* Sort the results based on the migration job name.
|
|
762
|
+
* Valid values are: "name", "name asc", and "name desc".
|
|
763
|
+
* @param {object} [options]
|
|
764
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
765
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
766
|
+
* The first element of the array is Array of [MigrationJob]{@link google.cloud.clouddms.v1.MigrationJob}.
|
|
767
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
768
|
+
* times as needed and will merge results from all the pages into this array.
|
|
769
|
+
* Note that it can affect your quota.
|
|
770
|
+
* We recommend using `listMigrationJobsAsync()`
|
|
771
|
+
* method described below for async iteration which you can stop as needed.
|
|
772
|
+
* Please see the
|
|
773
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
774
|
+
* for more details and examples.
|
|
775
|
+
*/
|
|
776
|
+
listMigrationJobs(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): Promise<[
|
|
777
|
+
protos.google.cloud.clouddms.v1.IMigrationJob[],
|
|
778
|
+
protos.google.cloud.clouddms.v1.IListMigrationJobsRequest | null,
|
|
779
|
+
protos.google.cloud.clouddms.v1.IListMigrationJobsResponse
|
|
780
|
+
]>;
|
|
343
781
|
listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
|
|
344
782
|
listMigrationJobs(request: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, protos.google.cloud.clouddms.v1.IListMigrationJobsResponse | null | undefined, protos.google.cloud.clouddms.v1.IMigrationJob>): void;
|
|
345
783
|
/**
|
|
@@ -427,14 +865,58 @@ export declare class DataMigrationServiceClient {
|
|
|
427
865
|
* Please see the
|
|
428
866
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
429
867
|
* for more details and examples.
|
|
430
|
-
* @example
|
|
431
|
-
*
|
|
432
|
-
* for await (const response of iterable) {
|
|
433
|
-
* // process response
|
|
434
|
-
* }
|
|
868
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.list_migration_jobs.js</caption>
|
|
869
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async
|
|
435
870
|
*/
|
|
436
871
|
listMigrationJobsAsync(request?: protos.google.cloud.clouddms.v1.IListMigrationJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IMigrationJob>;
|
|
437
|
-
|
|
872
|
+
/**
|
|
873
|
+
* Retrieve a list of all connection profiles in a given project and location.
|
|
874
|
+
*
|
|
875
|
+
* @param {Object} request
|
|
876
|
+
* The request object that will be sent.
|
|
877
|
+
* @param {string} request.parent
|
|
878
|
+
* Required. The parent, which owns this collection of connection profiles.
|
|
879
|
+
* @param {number} request.pageSize
|
|
880
|
+
* The maximum number of connection profiles to return. The service may return
|
|
881
|
+
* fewer than this value. If unspecified, at most 50 connection profiles will
|
|
882
|
+
* be returned. The maximum value is 1000; values above 1000 will be coerced
|
|
883
|
+
* to 1000.
|
|
884
|
+
* @param {string} request.pageToken
|
|
885
|
+
* A page token, received from a previous `ListConnectionProfiles` call.
|
|
886
|
+
* Provide this to retrieve the subsequent page.
|
|
887
|
+
*
|
|
888
|
+
* When paginating, all other parameters provided to `ListConnectionProfiles`
|
|
889
|
+
* must match the call that provided the page token.
|
|
890
|
+
* @param {string} request.filter
|
|
891
|
+
* A filter expression that filters connection profiles listed in the
|
|
892
|
+
* response. The expression must specify the field name, a comparison
|
|
893
|
+
* operator, and the value that you want to use for filtering. The value must
|
|
894
|
+
* be a string, a number, or a boolean. The comparison operator must be either
|
|
895
|
+
* =, !=, >, or <. For example, list connection profiles created this year by
|
|
896
|
+
* specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
|
|
897
|
+
* also filter nested fields. For example, you could specify **mySql.username
|
|
898
|
+
* = %lt;my_username%gt;** to list all connection profiles configured to
|
|
899
|
+
* connect with a specific username.
|
|
900
|
+
* @param {string} request.orderBy
|
|
901
|
+
* the order by fields for the result.
|
|
902
|
+
* @param {object} [options]
|
|
903
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
904
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
905
|
+
* The first element of the array is Array of [ConnectionProfile]{@link google.cloud.clouddms.v1.ConnectionProfile}.
|
|
906
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
907
|
+
* times as needed and will merge results from all the pages into this array.
|
|
908
|
+
* Note that it can affect your quota.
|
|
909
|
+
* We recommend using `listConnectionProfilesAsync()`
|
|
910
|
+
* method described below for async iteration which you can stop as needed.
|
|
911
|
+
* Please see the
|
|
912
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
913
|
+
* for more details and examples.
|
|
914
|
+
*/
|
|
915
|
+
listConnectionProfiles(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): Promise<[
|
|
916
|
+
protos.google.cloud.clouddms.v1.IConnectionProfile[],
|
|
917
|
+
protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest | null,
|
|
918
|
+
protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse
|
|
919
|
+
]>;
|
|
438
920
|
listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
|
|
439
921
|
listConnectionProfiles(request: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, callback: PaginationCallback<protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, protos.google.cloud.clouddms.v1.IListConnectionProfilesResponse | null | undefined, protos.google.cloud.clouddms.v1.IConnectionProfile>): void;
|
|
440
922
|
/**
|
|
@@ -520,11 +1002,8 @@ export declare class DataMigrationServiceClient {
|
|
|
520
1002
|
* Please see the
|
|
521
1003
|
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
522
1004
|
* for more details and examples.
|
|
523
|
-
* @example
|
|
524
|
-
*
|
|
525
|
-
* for await (const response of iterable) {
|
|
526
|
-
* // process response
|
|
527
|
-
* }
|
|
1005
|
+
* @example <caption>include:samples/generated/v1/data_migration_service.list_connection_profiles.js</caption>
|
|
1006
|
+
* region_tag:datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async
|
|
528
1007
|
*/
|
|
529
1008
|
listConnectionProfilesAsync(request?: protos.google.cloud.clouddms.v1.IListConnectionProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.clouddms.v1.IConnectionProfile>;
|
|
530
1009
|
/**
|