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