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