@google-cloud/dms 2.2.2 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // Copyright 2021 Google LLC
1
+ // Copyright 2023 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ import "google/api/client.proto";
21
21
  import "google/api/field_behavior.proto";
22
22
  import "google/api/resource.proto";
23
23
  import "google/cloud/clouddms/v1/clouddms_resources.proto";
24
+ import "google/cloud/clouddms/v1/conversionworkspace_resources.proto";
24
25
  import "google/longrunning/operations.proto";
25
26
  import "google/protobuf/field_mask.proto";
26
27
  import "google/protobuf/timestamp.proto";
@@ -36,10 +37,12 @@ option ruby_package = "Google::Cloud::CloudDMS::V1";
36
37
  // Database Migration service
37
38
  service DataMigrationService {
38
39
  option (google.api.default_host) = "datamigration.googleapis.com";
39
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
40
+ option (google.api.oauth_scopes) =
41
+ "https://www.googleapis.com/auth/cloud-platform";
40
42
 
41
43
  // Lists migration jobs in a given project and location.
42
- rpc ListMigrationJobs(ListMigrationJobsRequest) returns (ListMigrationJobsResponse) {
44
+ rpc ListMigrationJobs(ListMigrationJobsRequest)
45
+ returns (ListMigrationJobsResponse) {
43
46
  option (google.api.http) = {
44
47
  get: "/v1/{parent=projects/*/locations/*}/migrationJobs"
45
48
  };
@@ -55,12 +58,14 @@ service DataMigrationService {
55
58
  }
56
59
 
57
60
  // Creates a new migration job in a given project and location.
58
- rpc CreateMigrationJob(CreateMigrationJobRequest) returns (google.longrunning.Operation) {
61
+ rpc CreateMigrationJob(CreateMigrationJobRequest)
62
+ returns (google.longrunning.Operation) {
59
63
  option (google.api.http) = {
60
64
  post: "/v1/{parent=projects/*/locations/*}/migrationJobs"
61
65
  body: "migration_job"
62
66
  };
63
- option (google.api.method_signature) = "parent,migration_job,migration_job_id";
67
+ option (google.api.method_signature) =
68
+ "parent,migration_job,migration_job_id";
64
69
  option (google.longrunning.operation_info) = {
65
70
  response_type: "MigrationJob"
66
71
  metadata_type: "OperationMetadata"
@@ -68,7 +73,8 @@ service DataMigrationService {
68
73
  }
69
74
 
70
75
  // Updates the parameters of a single migration job.
71
- rpc UpdateMigrationJob(UpdateMigrationJobRequest) returns (google.longrunning.Operation) {
76
+ rpc UpdateMigrationJob(UpdateMigrationJobRequest)
77
+ returns (google.longrunning.Operation) {
72
78
  option (google.api.http) = {
73
79
  patch: "/v1/{migration_job.name=projects/*/locations/*/migrationJobs/*}"
74
80
  body: "migration_job"
@@ -81,7 +87,8 @@ service DataMigrationService {
81
87
  }
82
88
 
83
89
  // Deletes a single migration job.
84
- rpc DeleteMigrationJob(DeleteMigrationJobRequest) returns (google.longrunning.Operation) {
90
+ rpc DeleteMigrationJob(DeleteMigrationJobRequest)
91
+ returns (google.longrunning.Operation) {
85
92
  option (google.api.http) = {
86
93
  delete: "/v1/{name=projects/*/locations/*/migrationJobs/*}"
87
94
  };
@@ -93,7 +100,8 @@ service DataMigrationService {
93
100
  }
94
101
 
95
102
  // Start an already created migration job.
96
- rpc StartMigrationJob(StartMigrationJobRequest) returns (google.longrunning.Operation) {
103
+ rpc StartMigrationJob(StartMigrationJobRequest)
104
+ returns (google.longrunning.Operation) {
97
105
  option (google.api.http) = {
98
106
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:start"
99
107
  body: "*"
@@ -105,7 +113,8 @@ service DataMigrationService {
105
113
  }
106
114
 
107
115
  // Stops a running migration job.
108
- rpc StopMigrationJob(StopMigrationJobRequest) returns (google.longrunning.Operation) {
116
+ rpc StopMigrationJob(StopMigrationJobRequest)
117
+ returns (google.longrunning.Operation) {
109
118
  option (google.api.http) = {
110
119
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:stop"
111
120
  body: "*"
@@ -118,7 +127,8 @@ service DataMigrationService {
118
127
 
119
128
  // Resume a migration job that is currently stopped and is resumable (was
120
129
  // stopped during CDC phase).
121
- rpc ResumeMigrationJob(ResumeMigrationJobRequest) returns (google.longrunning.Operation) {
130
+ rpc ResumeMigrationJob(ResumeMigrationJobRequest)
131
+ returns (google.longrunning.Operation) {
122
132
  option (google.api.http) = {
123
133
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:resume"
124
134
  body: "*"
@@ -131,7 +141,8 @@ service DataMigrationService {
131
141
 
132
142
  // Promote a migration job, stopping replication to the destination and
133
143
  // promoting the destination to be a standalone database.
134
- rpc PromoteMigrationJob(PromoteMigrationJobRequest) returns (google.longrunning.Operation) {
144
+ rpc PromoteMigrationJob(PromoteMigrationJobRequest)
145
+ returns (google.longrunning.Operation) {
135
146
  option (google.api.http) = {
136
147
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:promote"
137
148
  body: "*"
@@ -144,7 +155,8 @@ service DataMigrationService {
144
155
 
145
156
  // Verify a migration job, making sure the destination can reach the source
146
157
  // and that all configuration and prerequisites are met.
147
- rpc VerifyMigrationJob(VerifyMigrationJobRequest) returns (google.longrunning.Operation) {
158
+ rpc VerifyMigrationJob(VerifyMigrationJobRequest)
159
+ returns (google.longrunning.Operation) {
148
160
  option (google.api.http) = {
149
161
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:verify"
150
162
  body: "*"
@@ -158,7 +170,8 @@ service DataMigrationService {
158
170
  // Restart a stopped or failed migration job, resetting the destination
159
171
  // instance to its original state and starting the migration process from
160
172
  // scratch.
161
- rpc RestartMigrationJob(RestartMigrationJobRequest) returns (google.longrunning.Operation) {
173
+ rpc RestartMigrationJob(RestartMigrationJobRequest)
174
+ returns (google.longrunning.Operation) {
162
175
  option (google.api.http) = {
163
176
  post: "/v1/{name=projects/*/locations/*/migrationJobs/*}:restart"
164
177
  body: "*"
@@ -178,8 +191,10 @@ service DataMigrationService {
178
191
  };
179
192
  }
180
193
 
181
- // Retrieve a list of all connection profiles in a given project and location.
182
- rpc ListConnectionProfiles(ListConnectionProfilesRequest) returns (ListConnectionProfilesResponse) {
194
+ // Retrieves a list of all connection profiles in a given project and
195
+ // location.
196
+ rpc ListConnectionProfiles(ListConnectionProfilesRequest)
197
+ returns (ListConnectionProfilesResponse) {
183
198
  option (google.api.http) = {
184
199
  get: "/v1/{parent=projects/*/locations/*}/connectionProfiles"
185
200
  };
@@ -187,7 +202,8 @@ service DataMigrationService {
187
202
  }
188
203
 
189
204
  // Gets details of a single connection profile.
190
- rpc GetConnectionProfile(GetConnectionProfileRequest) returns (ConnectionProfile) {
205
+ rpc GetConnectionProfile(GetConnectionProfileRequest)
206
+ returns (ConnectionProfile) {
191
207
  option (google.api.http) = {
192
208
  get: "/v1/{name=projects/*/locations/*/connectionProfiles/*}"
193
209
  };
@@ -195,12 +211,14 @@ service DataMigrationService {
195
211
  }
196
212
 
197
213
  // Creates a new connection profile in a given project and location.
198
- rpc CreateConnectionProfile(CreateConnectionProfileRequest) returns (google.longrunning.Operation) {
214
+ rpc CreateConnectionProfile(CreateConnectionProfileRequest)
215
+ returns (google.longrunning.Operation) {
199
216
  option (google.api.http) = {
200
217
  post: "/v1/{parent=projects/*/locations/*}/connectionProfiles"
201
218
  body: "connection_profile"
202
219
  };
203
- option (google.api.method_signature) = "parent,connection_profile,connection_profile_id";
220
+ option (google.api.method_signature) =
221
+ "parent,connection_profile,connection_profile_id";
204
222
  option (google.longrunning.operation_info) = {
205
223
  response_type: "ConnectionProfile"
206
224
  metadata_type: "OperationMetadata"
@@ -208,7 +226,8 @@ service DataMigrationService {
208
226
  }
209
227
 
210
228
  // Update the configuration of a single connection profile.
211
- rpc UpdateConnectionProfile(UpdateConnectionProfileRequest) returns (google.longrunning.Operation) {
229
+ rpc UpdateConnectionProfile(UpdateConnectionProfileRequest)
230
+ returns (google.longrunning.Operation) {
212
231
  option (google.api.http) = {
213
232
  patch: "/v1/{connection_profile.name=projects/*/locations/*/connectionProfiles/*}"
214
233
  body: "connection_profile"
@@ -223,7 +242,8 @@ service DataMigrationService {
223
242
  // Deletes a single Database Migration Service connection profile.
224
243
  // A connection profile can only be deleted if it is not in use by any
225
244
  // active migration jobs.
226
- rpc DeleteConnectionProfile(DeleteConnectionProfileRequest) returns (google.longrunning.Operation) {
245
+ rpc DeleteConnectionProfile(DeleteConnectionProfileRequest)
246
+ returns (google.longrunning.Operation) {
227
247
  option (google.api.http) = {
228
248
  delete: "/v1/{name=projects/*/locations/*/connectionProfiles/*}"
229
249
  };
@@ -233,11 +253,242 @@ service DataMigrationService {
233
253
  metadata_type: "OperationMetadata"
234
254
  };
235
255
  }
256
+
257
+ // Creates a new private connection in a given project and location.
258
+ rpc CreatePrivateConnection(CreatePrivateConnectionRequest)
259
+ returns (google.longrunning.Operation) {
260
+ option (google.api.http) = {
261
+ post: "/v1/{parent=projects/*/locations/*}/privateConnections"
262
+ body: "private_connection"
263
+ };
264
+ option (google.api.method_signature) =
265
+ "parent,private_connection,private_connection_id";
266
+ option (google.longrunning.operation_info) = {
267
+ response_type: "PrivateConnection"
268
+ metadata_type: "OperationMetadata"
269
+ };
270
+ }
271
+
272
+ // Gets details of a single private connection.
273
+ rpc GetPrivateConnection(GetPrivateConnectionRequest)
274
+ returns (PrivateConnection) {
275
+ option (google.api.http) = {
276
+ get: "/v1/{name=projects/*/locations/*/privateConnections/*}"
277
+ };
278
+ option (google.api.method_signature) = "name";
279
+ }
280
+
281
+ // Retrieves a list of private connections in a given project and location.
282
+ rpc ListPrivateConnections(ListPrivateConnectionsRequest)
283
+ returns (ListPrivateConnectionsResponse) {
284
+ option (google.api.http) = {
285
+ get: "/v1/{parent=projects/*/locations/*}/privateConnections"
286
+ };
287
+ option (google.api.method_signature) = "parent";
288
+ }
289
+
290
+ // Deletes a single Database Migration Service private connection.
291
+ rpc DeletePrivateConnection(DeletePrivateConnectionRequest)
292
+ returns (google.longrunning.Operation) {
293
+ option (google.api.http) = {
294
+ delete: "/v1/{name=projects/*/locations/*/privateConnections/*}"
295
+ };
296
+ option (google.api.method_signature) = "name";
297
+ option (google.longrunning.operation_info) = {
298
+ response_type: "google.protobuf.Empty"
299
+ metadata_type: "OperationMetadata"
300
+ };
301
+ }
302
+
303
+ // Gets details of a single conversion workspace.
304
+ rpc GetConversionWorkspace(GetConversionWorkspaceRequest)
305
+ returns (ConversionWorkspace) {
306
+ option (google.api.http) = {
307
+ get: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}"
308
+ };
309
+ option (google.api.method_signature) = "name";
310
+ }
311
+
312
+ // Lists conversion workspaces in a given project and location.
313
+ rpc ListConversionWorkspaces(ListConversionWorkspacesRequest)
314
+ returns (ListConversionWorkspacesResponse) {
315
+ option (google.api.http) = {
316
+ get: "/v1/{parent=projects/*/locations/*}/conversionWorkspaces"
317
+ };
318
+ option (google.api.method_signature) = "parent";
319
+ }
320
+
321
+ // Creates a new conversion workspace in a given project and location.
322
+ rpc CreateConversionWorkspace(CreateConversionWorkspaceRequest)
323
+ returns (google.longrunning.Operation) {
324
+ option (google.api.http) = {
325
+ post: "/v1/{parent=projects/*/locations/*}/conversionWorkspaces"
326
+ body: "conversion_workspace"
327
+ };
328
+ option (google.api.method_signature) =
329
+ "parent,conversion_workspace,conversion_workspace_id";
330
+ option (google.longrunning.operation_info) = {
331
+ response_type: "ConversionWorkspace"
332
+ metadata_type: "OperationMetadata"
333
+ };
334
+ }
335
+
336
+ // Updates the parameters of a single conversion workspace.
337
+ rpc UpdateConversionWorkspace(UpdateConversionWorkspaceRequest)
338
+ returns (google.longrunning.Operation) {
339
+ option (google.api.http) = {
340
+ patch: "/v1/{conversion_workspace.name=projects/*/locations/*/conversionWorkspaces/*}"
341
+ body: "conversion_workspace"
342
+ };
343
+ option (google.api.method_signature) = "conversion_workspace,update_mask";
344
+ option (google.longrunning.operation_info) = {
345
+ response_type: "ConversionWorkspace"
346
+ metadata_type: "OperationMetadata"
347
+ };
348
+ }
349
+
350
+ // Deletes a single conversion workspace.
351
+ rpc DeleteConversionWorkspace(DeleteConversionWorkspaceRequest)
352
+ returns (google.longrunning.Operation) {
353
+ option (google.api.http) = {
354
+ delete: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}"
355
+ };
356
+ option (google.api.method_signature) = "name";
357
+ option (google.longrunning.operation_info) = {
358
+ response_type: "google.protobuf.Empty"
359
+ metadata_type: "OperationMetadata"
360
+ };
361
+ }
362
+
363
+ // Imports a snapshot of the source database into the
364
+ // conversion workspace.
365
+ rpc SeedConversionWorkspace(SeedConversionWorkspaceRequest)
366
+ returns (google.longrunning.Operation) {
367
+ option (google.api.http) = {
368
+ post: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}:seed"
369
+ body: "*"
370
+ };
371
+ option (google.longrunning.operation_info) = {
372
+ response_type: "ConversionWorkspace"
373
+ metadata_type: "OperationMetadata"
374
+ };
375
+ }
376
+
377
+ // Imports the mapping rules for a given conversion workspace.
378
+ // Supports various formats of external rules files.
379
+ rpc ImportMappingRules(ImportMappingRulesRequest)
380
+ returns (google.longrunning.Operation) {
381
+ option (google.api.http) = {
382
+ post: "/v1/{parent=projects/*/locations/*/conversionWorkspaces/*}/mappingRules:import"
383
+ body: "*"
384
+ };
385
+ option (google.longrunning.operation_info) = {
386
+ response_type: "ConversionWorkspace"
387
+ metadata_type: "OperationMetadata"
388
+ };
389
+ }
390
+
391
+ // Creates a draft tree schema for the destination database.
392
+ rpc ConvertConversionWorkspace(ConvertConversionWorkspaceRequest)
393
+ returns (google.longrunning.Operation) {
394
+ option (google.api.http) = {
395
+ post: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}:convert"
396
+ body: "*"
397
+ };
398
+ option (google.longrunning.operation_info) = {
399
+ response_type: "ConversionWorkspace"
400
+ metadata_type: "OperationMetadata"
401
+ };
402
+ }
403
+
404
+ // Marks all the data in the conversion workspace as committed.
405
+ rpc CommitConversionWorkspace(CommitConversionWorkspaceRequest)
406
+ returns (google.longrunning.Operation) {
407
+ option (google.api.http) = {
408
+ post: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}:commit"
409
+ body: "*"
410
+ };
411
+ option (google.longrunning.operation_info) = {
412
+ response_type: "ConversionWorkspace"
413
+ metadata_type: "OperationMetadata"
414
+ };
415
+ }
416
+
417
+ // Rolls back a conversion workspace to the last committed snapshot.
418
+ rpc RollbackConversionWorkspace(RollbackConversionWorkspaceRequest)
419
+ returns (google.longrunning.Operation) {
420
+ option (google.api.http) = {
421
+ post: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}:rollback"
422
+ body: "*"
423
+ };
424
+ option (google.longrunning.operation_info) = {
425
+ response_type: "ConversionWorkspace"
426
+ metadata_type: "OperationMetadata"
427
+ };
428
+ }
429
+
430
+ // Applies draft tree onto a specific destination database.
431
+ rpc ApplyConversionWorkspace(ApplyConversionWorkspaceRequest)
432
+ returns (google.longrunning.Operation) {
433
+ option (google.api.http) = {
434
+ post: "/v1/{name=projects/*/locations/*/conversionWorkspaces/*}:apply"
435
+ body: "*"
436
+ };
437
+ option (google.longrunning.operation_info) = {
438
+ response_type: "ConversionWorkspace"
439
+ metadata_type: "OperationMetadata"
440
+ };
441
+ }
442
+
443
+ // Describes the database entities tree for a specific conversion workspace
444
+ // and a specific tree type.
445
+ //
446
+ // Database entities are not resources like conversion workspaces or mapping
447
+ // rules, and they can't be created, updated or deleted. Instead, they are
448
+ // simple data objects describing the structure of the client database.
449
+ rpc DescribeDatabaseEntities(DescribeDatabaseEntitiesRequest)
450
+ returns (DescribeDatabaseEntitiesResponse) {
451
+ option (google.api.http) = {
452
+ get: "/v1/{conversion_workspace=projects/*/locations/*/conversionWorkspaces/*}:describeDatabaseEntities"
453
+ };
454
+ }
455
+
456
+ // Searches/lists the background jobs for a specific
457
+ // conversion workspace.
458
+ //
459
+ // The background jobs are not resources like conversion workspaces or
460
+ // mapping rules, and they can't be created, updated or deleted.
461
+ // Instead, they are a way to expose the data plane jobs log.
462
+ rpc SearchBackgroundJobs(SearchBackgroundJobsRequest)
463
+ returns (SearchBackgroundJobsResponse) {
464
+ option (google.api.http) = {
465
+ get: "/v1/{conversion_workspace=projects/*/locations/*/conversionWorkspaces/*}:searchBackgroundJobs"
466
+ };
467
+ }
468
+
469
+ // Retrieves a list of committed revisions of a specific conversion
470
+ // workspace.
471
+ rpc DescribeConversionWorkspaceRevisions(
472
+ DescribeConversionWorkspaceRevisionsRequest)
473
+ returns (DescribeConversionWorkspaceRevisionsResponse) {
474
+ option (google.api.http) = {
475
+ get: "/v1/{conversion_workspace=projects/*/locations/*/conversionWorkspaces/*}:describeConversionWorkspaceRevisions"
476
+ };
477
+ }
478
+
479
+ // Fetches a set of static IP addresses that need to be allowlisted by the
480
+ // customer when using the static-IP connectivity method.
481
+ rpc FetchStaticIps(FetchStaticIpsRequest) returns (FetchStaticIpsResponse) {
482
+ option (google.api.http) = {
483
+ get: "/v1/{name=projects/*/locations/*}:fetchStaticIps"
484
+ };
485
+ option (google.api.method_signature) = "name";
486
+ }
236
487
  }
237
488
 
238
- // Retrieve a list of all migration jobs in a given project and location.
489
+ // Retrieves a list of all migration jobs in a given project and location.
239
490
  message ListMigrationJobsRequest {
240
- // Required. The parent, which owns this collection of migrationJobs.
491
+ // Required. The parent which owns this collection of migrationJobs.
241
492
  string parent = 1 [
242
493
  (google.api.field_behavior) = REQUIRED,
243
494
  (google.api.resource_reference) = {
@@ -247,7 +498,7 @@ message ListMigrationJobsRequest {
247
498
 
248
499
  // The maximum number of migration jobs to return. The service may return
249
500
  // fewer than this value. If unspecified, at most 50 migration jobs will be
250
- // returned. The maximum value is 1000; values above 1000 will be coerced to
501
+ // returned. The maximum value is 1000; values above 1000 are coerced to
251
502
  // 1000.
252
503
  int32 page_size = 2;
253
504
 
@@ -279,7 +530,7 @@ message ListMigrationJobsResponse {
279
530
  // The list of migration jobs objects.
280
531
  repeated MigrationJob migration_jobs = 1;
281
532
 
282
- // A token, which can be sent as `page_token` to retrieve the next page.
533
+ // A token which can be sent as `page_token` to retrieve the next page.
283
534
  // If this field is omitted, there are no subsequent pages.
284
535
  string next_page_token = 2;
285
536
 
@@ -301,7 +552,7 @@ message GetMigrationJobRequest {
301
552
  // Request message to create a new Database Migration Service migration job
302
553
  // in the specified project and region.
303
554
  message CreateMigrationJobRequest {
304
- // Required. The parent, which owns this collection of migration jobs.
555
+ // Required. The parent which owns this collection of migration jobs.
305
556
  string parent = 1 [
306
557
  (google.api.field_behavior) = REQUIRED,
307
558
  (google.api.resource_reference) = {
@@ -317,31 +568,32 @@ message CreateMigrationJobRequest {
317
568
  // object.
318
569
  MigrationJob migration_job = 3 [(google.api.field_behavior) = REQUIRED];
319
570
 
320
- // A unique id used to identify the request. If the server receives two
321
- // requests with the same id, then the second request will be ignored.
571
+ // A unique ID used to identify the request. If the server receives two
572
+ // requests with the same ID, then the second request is ignored.
322
573
  //
323
574
  // It is recommended to always set this value to a UUID.
324
575
  //
325
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
576
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
326
577
  // (_), and hyphens (-). The maximum length is 40 characters.
327
578
  string request_id = 4;
328
579
  }
329
580
 
330
581
  // Request message for 'UpdateMigrationJob' request.
331
582
  message UpdateMigrationJobRequest {
332
- // Required. Field mask is used to specify the fields to be overwritten in the
333
- // migration job resource by the update.
334
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
583
+ // Required. Field mask is used to specify the fields to be overwritten by the
584
+ // update in the conversion workspace resource.
585
+ google.protobuf.FieldMask update_mask = 1
586
+ [(google.api.field_behavior) = REQUIRED];
335
587
 
336
588
  // Required. The migration job parameters to update.
337
589
  MigrationJob migration_job = 2 [(google.api.field_behavior) = REQUIRED];
338
590
 
339
- // A unique id used to identify the request. If the server receives two
340
- // requests with the same id, then the second request will be ignored.
591
+ // A unique ID used to identify the request. If the server receives two
592
+ // requests with the same ID, then the second request is ignored.
341
593
  //
342
594
  // It is recommended to always set this value to a UUID.
343
595
  //
344
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
596
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
345
597
  // (_), and hyphens (-). The maximum length is 40 characters.
346
598
  string request_id = 3;
347
599
  }
@@ -356,12 +608,12 @@ message DeleteMigrationJobRequest {
356
608
  }
357
609
  ];
358
610
 
359
- // A unique id used to identify the request. If the server receives two
360
- // requests with the same id, then the second request will be ignored.
611
+ // A unique ID used to identify the request. If the server receives two
612
+ // requests with the same ID, then the second request is ignored.
361
613
  //
362
614
  // It is recommended to always set this value to a UUID.
363
615
  //
364
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
616
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
365
617
  // (_), and hyphens (-). The maximum length is 40 characters.
366
618
  string request_id = 2;
367
619
 
@@ -375,56 +627,56 @@ message DeleteMigrationJobRequest {
375
627
  message StartMigrationJobRequest {
376
628
  // Name of the migration job resource to start.
377
629
  string name = 1 [(google.api.resource_reference) = {
378
- type: "datamigration.googleapis.com/MigrationJob"
379
- }];
630
+ type: "datamigration.googleapis.com/MigrationJob"
631
+ }];
380
632
  }
381
633
 
382
634
  // Request message for 'StopMigrationJob' request.
383
635
  message StopMigrationJobRequest {
384
636
  // Name of the migration job resource to stop.
385
637
  string name = 1 [(google.api.resource_reference) = {
386
- type: "datamigration.googleapis.com/MigrationJob"
387
- }];
638
+ type: "datamigration.googleapis.com/MigrationJob"
639
+ }];
388
640
  }
389
641
 
390
642
  // Request message for 'ResumeMigrationJob' request.
391
643
  message ResumeMigrationJobRequest {
392
644
  // Name of the migration job resource to resume.
393
645
  string name = 1 [(google.api.resource_reference) = {
394
- type: "datamigration.googleapis.com/MigrationJob"
395
- }];
646
+ type: "datamigration.googleapis.com/MigrationJob"
647
+ }];
396
648
  }
397
649
 
398
650
  // Request message for 'PromoteMigrationJob' request.
399
651
  message PromoteMigrationJobRequest {
400
652
  // Name of the migration job resource to promote.
401
653
  string name = 1 [(google.api.resource_reference) = {
402
- type: "datamigration.googleapis.com/MigrationJob"
403
- }];
654
+ type: "datamigration.googleapis.com/MigrationJob"
655
+ }];
404
656
  }
405
657
 
406
658
  // Request message for 'VerifyMigrationJob' request.
407
659
  message VerifyMigrationJobRequest {
408
660
  // Name of the migration job resource to verify.
409
661
  string name = 1 [(google.api.resource_reference) = {
410
- type: "datamigration.googleapis.com/MigrationJob"
411
- }];
662
+ type: "datamigration.googleapis.com/MigrationJob"
663
+ }];
412
664
  }
413
665
 
414
666
  // Request message for 'RestartMigrationJob' request.
415
667
  message RestartMigrationJobRequest {
416
668
  // Name of the migration job resource to restart.
417
669
  string name = 1 [(google.api.resource_reference) = {
418
- type: "datamigration.googleapis.com/MigrationJob"
419
- }];
670
+ type: "datamigration.googleapis.com/MigrationJob"
671
+ }];
420
672
  }
421
673
 
422
674
  // Request message for 'GenerateSshScript' request.
423
675
  message GenerateSshScriptRequest {
424
676
  // Name of the migration job resource to generate the SSH script.
425
677
  string migration_job = 1 [(google.api.resource_reference) = {
426
- type: "datamigration.googleapis.com/MigrationJob"
427
- }];
678
+ type: "datamigration.googleapis.com/MigrationJob"
679
+ }];
428
680
 
429
681
  // Required. Bastion VM Instance name to use or to create.
430
682
  string vm = 2 [(google.api.field_behavior) = REQUIRED];
@@ -438,7 +690,7 @@ message GenerateSshScriptRequest {
438
690
  VmSelectionConfig vm_selection_config = 101;
439
691
  }
440
692
 
441
- // The port that will be open on the bastion host
693
+ // The port that will be open on the bastion host.
442
694
  int32 vm_port = 3;
443
695
  }
444
696
 
@@ -468,7 +720,7 @@ message SshScript {
468
720
 
469
721
  // Request message for 'ListConnectionProfiles' request.
470
722
  message ListConnectionProfilesRequest {
471
- // Required. The parent, which owns this collection of connection profiles.
723
+ // Required. The parent which owns this collection of connection profiles.
472
724
  string parent = 1 [
473
725
  (google.api.field_behavior) = REQUIRED,
474
726
  (google.api.resource_reference) = {
@@ -478,7 +730,7 @@ message ListConnectionProfilesRequest {
478
730
 
479
731
  // The maximum number of connection profiles to return. The service may return
480
732
  // fewer than this value. If unspecified, at most 50 connection profiles will
481
- // be returned. The maximum value is 1000; values above 1000 will be coerced
733
+ // be returned. The maximum value is 1000; values above 1000 are coerced
482
734
  // to 1000.
483
735
  int32 page_size = 2;
484
736
 
@@ -500,7 +752,7 @@ message ListConnectionProfilesRequest {
500
752
  // connect with a specific username.
501
753
  string filter = 4;
502
754
 
503
- // the order by fields for the result.
755
+ // A comma-separated list of fields to order results according to.
504
756
  string order_by = 5;
505
757
  }
506
758
 
@@ -509,7 +761,7 @@ message ListConnectionProfilesResponse {
509
761
  // The response list of connection profiles.
510
762
  repeated ConnectionProfile connection_profiles = 1;
511
763
 
512
- // A token, which can be sent as `page_token` to retrieve the next page.
764
+ // A token which can be sent as `page_token` to retrieve the next page.
513
765
  // If this field is omitted, there are no subsequent pages.
514
766
  string next_page_token = 2;
515
767
 
@@ -530,7 +782,7 @@ message GetConnectionProfileRequest {
530
782
 
531
783
  // Request message for 'CreateConnectionProfile' request.
532
784
  message CreateConnectionProfileRequest {
533
- // Required. The parent, which owns this collection of connection profiles.
785
+ // Required. The parent which owns this collection of connection profiles.
534
786
  string parent = 1 [
535
787
  (google.api.field_behavior) = REQUIRED,
536
788
  (google.api.resource_reference) = {
@@ -542,35 +794,58 @@ message CreateConnectionProfileRequest {
542
794
  string connection_profile_id = 2 [(google.api.field_behavior) = REQUIRED];
543
795
 
544
796
  // Required. The create request body including the connection profile data
545
- ConnectionProfile connection_profile = 3 [(google.api.field_behavior) = REQUIRED];
797
+ ConnectionProfile connection_profile = 3
798
+ [(google.api.field_behavior) = REQUIRED];
546
799
 
547
- // A unique id used to identify the request. If the server receives two
548
- // requests with the same id, then the second request will be ignored.
800
+ // Optional. A unique ID used to identify the request. If the server receives
801
+ // two requests with the same ID, then the second request is ignored.
549
802
  //
550
803
  // It is recommended to always set this value to a UUID.
551
804
  //
552
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
805
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
553
806
  // (_), and hyphens (-). The maximum length is 40 characters.
554
- string request_id = 4;
807
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
808
+
809
+ // Optional. Only validate the connection profile, but don't create any
810
+ // resources. The default is false. Only supported for Oracle connection
811
+ // profiles.
812
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
813
+
814
+ // Optional. Create the connection profile without validating it.
815
+ // The default is false.
816
+ // Only supported for Oracle connection profiles.
817
+ bool skip_validation = 6 [(google.api.field_behavior) = OPTIONAL];
555
818
  }
556
819
 
557
820
  // Request message for 'UpdateConnectionProfile' request.
558
821
  message UpdateConnectionProfileRequest {
559
- // Required. Field mask is used to specify the fields to be overwritten in the
560
- // connection profile resource by the update.
561
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
822
+ // Required. Field mask is used to specify the fields to be overwritten by the
823
+ // update in the conversion workspace resource.
824
+ google.protobuf.FieldMask update_mask = 1
825
+ [(google.api.field_behavior) = REQUIRED];
562
826
 
563
827
  // Required. The connection profile parameters to update.
564
- ConnectionProfile connection_profile = 2 [(google.api.field_behavior) = REQUIRED];
828
+ ConnectionProfile connection_profile = 2
829
+ [(google.api.field_behavior) = REQUIRED];
565
830
 
566
- // A unique id used to identify the request. If the server receives two
567
- // requests with the same id, then the second request will be ignored.
831
+ // Optional. A unique ID used to identify the request. If the server receives
832
+ // two requests with the same ID, then the second request is ignored.
568
833
  //
569
834
  // It is recommended to always set this value to a UUID.
570
835
  //
571
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
836
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
572
837
  // (_), and hyphens (-). The maximum length is 40 characters.
573
- string request_id = 3;
838
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
839
+
840
+ // Optional. Only validate the connection profile, but don't update any
841
+ // resources. The default is false. Only supported for Oracle connection
842
+ // profiles.
843
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
844
+
845
+ // Optional. Update the connection profile without validating it.
846
+ // The default is false.
847
+ // Only supported for Oracle connection profiles.
848
+ bool skip_validation = 5 [(google.api.field_behavior) = OPTIONAL];
574
849
  }
575
850
 
576
851
  // Request message for 'DeleteConnectionProfile' request.
@@ -583,12 +858,12 @@ message DeleteConnectionProfileRequest {
583
858
  }
584
859
  ];
585
860
 
586
- // A unique id used to identify the request. If the server receives two
587
- // requests with the same id, then the second request will be ignored.
861
+ // A unique ID used to identify the request. If the server receives two
862
+ // requests with the same ID, then the second request is ignored.
588
863
  //
589
864
  // It is recommended to always set this value to a UUID.
590
865
  //
591
- // The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
866
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
592
867
  // (_), and hyphens (-). The maximum length is 40 characters.
593
868
  string request_id = 2;
594
869
 
@@ -597,13 +872,126 @@ message DeleteConnectionProfileRequest {
597
872
  bool force = 3;
598
873
  }
599
874
 
875
+ // Request message to create a new private connection in the specified project
876
+ // and region.
877
+ message CreatePrivateConnectionRequest {
878
+ // Required. The parent that owns the collection of PrivateConnections.
879
+ string parent = 1 [
880
+ (google.api.field_behavior) = REQUIRED,
881
+ (google.api.resource_reference) = {
882
+ child_type: "datamigration.googleapis.com/PrivateConnection"
883
+ }
884
+ ];
885
+
886
+ // Required. The private connection identifier.
887
+ string private_connection_id = 2 [(google.api.field_behavior) = REQUIRED];
888
+
889
+ // Required. The private connection resource to create.
890
+ PrivateConnection private_connection = 3
891
+ [(google.api.field_behavior) = REQUIRED];
892
+
893
+ // Optional. A unique ID used to identify the request. If the server receives
894
+ // two requests with the same ID, then the second request is ignored.
895
+ //
896
+ // It is recommended to always set this value to a UUID.
897
+ //
898
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
899
+ // (_), and hyphens (-). The maximum length is 40 characters.
900
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
901
+
902
+ // Optional. If set to true, will skip validations.
903
+ bool skip_validation = 5 [(google.api.field_behavior) = OPTIONAL];
904
+ }
905
+
906
+ // Request message to retrieve a list of private connections in a given project
907
+ // and location.
908
+ message ListPrivateConnectionsRequest {
909
+ // Required. The parent that owns the collection of private connections.
910
+ string parent = 1 [
911
+ (google.api.field_behavior) = REQUIRED,
912
+ (google.api.resource_reference) = {
913
+ child_type: "datamigration.googleapis.com/PrivateConnection"
914
+ }
915
+ ];
916
+
917
+ // Maximum number of private connections to return.
918
+ // If unspecified, at most 50 private connections that are returned.
919
+ // The maximum value is 1000; values above 1000 are coerced to 1000.
920
+ int32 page_size = 2;
921
+
922
+ // Page token received from a previous `ListPrivateConnections` call.
923
+ // Provide this to retrieve the subsequent page.
924
+ //
925
+ // When paginating, all other parameters provided to
926
+ // `ListPrivateConnections` must match the call that provided the page
927
+ // token.
928
+ string page_token = 3;
929
+
930
+ // A filter expression that filters private connections listed in the
931
+ // response. The expression must specify the field name, a comparison
932
+ // operator, and the value that you want to use for filtering. The value must
933
+ // be a string, a number, or a boolean. The comparison operator must be either
934
+ // =, !=, >, or <. For example, list private connections created this year by
935
+ // specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
936
+ string filter = 4;
937
+
938
+ // Order by fields for the result.
939
+ string order_by = 5;
940
+ }
941
+
942
+ // Response message for 'ListPrivateConnections' request.
943
+ message ListPrivateConnectionsResponse {
944
+ // List of private connections.
945
+ repeated PrivateConnection private_connections = 1;
946
+
947
+ // A token which can be sent as `page_token` to retrieve the next page.
948
+ // If this field is omitted, there are no subsequent pages.
949
+ string next_page_token = 2;
950
+
951
+ // Locations that could not be reached.
952
+ repeated string unreachable = 3;
953
+ }
954
+
955
+ // Request message to delete a private connection.
956
+ message DeletePrivateConnectionRequest {
957
+ // Required. The name of the private connection to delete.
958
+ string name = 1 [
959
+ (google.api.field_behavior) = REQUIRED,
960
+ (google.api.resource_reference) = {
961
+ type: "datamigration.googleapis.com/PrivateConnection"
962
+ }
963
+ ];
964
+
965
+ // Optional. A unique ID used to identify the request. If the server receives
966
+ // two requests with the same ID, then the second request is ignored.
967
+ //
968
+ // It is recommended to always set this value to a UUID.
969
+ //
970
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
971
+ // (_), and hyphens (-). The maximum length is 40 characters.
972
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
973
+ }
974
+
975
+ // Request message to get a private connection resource.
976
+ message GetPrivateConnectionRequest {
977
+ // Required. The name of the private connection to get.
978
+ string name = 1 [
979
+ (google.api.field_behavior) = REQUIRED,
980
+ (google.api.resource_reference) = {
981
+ type: "datamigration.googleapis.com/PrivateConnection"
982
+ }
983
+ ];
984
+ }
985
+
600
986
  // Represents the metadata of the long-running operation.
601
987
  message OperationMetadata {
602
988
  // Output only. The time the operation was created.
603
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
989
+ google.protobuf.Timestamp create_time = 1
990
+ [(google.api.field_behavior) = OUTPUT_ONLY];
604
991
 
605
992
  // Output only. The time the operation finished running.
606
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
993
+ google.protobuf.Timestamp end_time = 2
994
+ [(google.api.field_behavior) = OUTPUT_ONLY];
607
995
 
608
996
  // Output only. Server-defined resource path for the target of the operation.
609
997
  string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -616,10 +1004,409 @@ message OperationMetadata {
616
1004
 
617
1005
  // Output only. Identifies whether the user has requested cancellation
618
1006
  // of the operation. Operations that have successfully been cancelled
619
- // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
620
- // corresponding to `Code.CANCELLED`.
1007
+ // have [Operation.error][] value with a
1008
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
1009
+ // `Code.CANCELLED`.
621
1010
  bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
622
1011
 
623
1012
  // Output only. API version used to start the operation.
624
1013
  string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
625
1014
  }
1015
+
1016
+ // Retrieve a list of all conversion workspaces in a given project and location.
1017
+ message ListConversionWorkspacesRequest {
1018
+ // Required. The parent which owns this collection of conversion workspaces.
1019
+ string parent = 1 [
1020
+ (google.api.field_behavior) = REQUIRED,
1021
+ (google.api.resource_reference) = {
1022
+ child_type: "datamigration.googleapis.com/ConversionWorkspace"
1023
+ }
1024
+ ];
1025
+
1026
+ // The maximum number of conversion workspaces to return. The service may
1027
+ // return fewer than this value. If unspecified, at most 50 sets are returned.
1028
+ int32 page_size = 2;
1029
+
1030
+ // The nextPageToken value received in the previous call to
1031
+ // conversionWorkspaces.list, used in the subsequent request to retrieve the
1032
+ // next page of results. On first call this should be left blank. When
1033
+ // paginating, all other parameters provided to conversionWorkspaces.list must
1034
+ // match the call that provided the page token.
1035
+ string page_token = 3;
1036
+
1037
+ // A filter expression that filters conversion workspaces listed in the
1038
+ // response. The expression must specify the field name, a comparison
1039
+ // operator, and the value that you want to use for filtering. The value must
1040
+ // be a string, a number, or a boolean. The comparison operator must be either
1041
+ // =, !=, >, or <. For example, list conversion workspaces created this year
1042
+ // by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can
1043
+ // also filter nested fields. For example, you could specify
1044
+ // **source.version = "12.c.1"** to select all conversion workspaces with
1045
+ // source database version equal to 12.c.1.
1046
+ string filter = 4;
1047
+ }
1048
+
1049
+ // Response message for 'ListConversionWorkspaces' request.
1050
+ message ListConversionWorkspacesResponse {
1051
+ // The list of conversion workspace objects.
1052
+ repeated ConversionWorkspace conversion_workspaces = 1;
1053
+
1054
+ // A token which can be sent as `page_token` to retrieve the next page.
1055
+ // If this field is omitted, there are no subsequent pages.
1056
+ string next_page_token = 2;
1057
+
1058
+ // Locations that could not be reached.
1059
+ repeated string unreachable = 3;
1060
+ }
1061
+
1062
+ // Request message for 'GetConversionWorkspace' request.
1063
+ message GetConversionWorkspaceRequest {
1064
+ // Required. Name of the conversion workspace resource to get.
1065
+ string name = 1 [
1066
+ (google.api.field_behavior) = REQUIRED,
1067
+ (google.api.resource_reference) = {
1068
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1069
+ }
1070
+ ];
1071
+ }
1072
+
1073
+ // Request message to create a new Conversion Workspace
1074
+ // in the specified project and region.
1075
+ message CreateConversionWorkspaceRequest {
1076
+ // Required. The parent which owns this collection of conversion workspaces.
1077
+ string parent = 1 [
1078
+ (google.api.field_behavior) = REQUIRED,
1079
+ (google.api.resource_reference) = {
1080
+ child_type: "datamigration.googleapis.com/ConversionWorkspace"
1081
+ }
1082
+ ];
1083
+
1084
+ // Required. The ID of the conversion workspace to create.
1085
+ string conversion_workspace_id = 2 [(google.api.field_behavior) = REQUIRED];
1086
+
1087
+ // Required. Represents a conversion workspace object.
1088
+ ConversionWorkspace conversion_workspace = 3
1089
+ [(google.api.field_behavior) = REQUIRED];
1090
+
1091
+ // A unique ID used to identify the request. If the server receives two
1092
+ // requests with the same ID, then the second request is ignored.
1093
+ //
1094
+ // It is recommended to always set this value to a UUID.
1095
+ //
1096
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1097
+ // (_), and hyphens (-). The maximum length is 40 characters.
1098
+ string request_id = 4;
1099
+ }
1100
+
1101
+ // Request message for 'UpdateConversionWorkspace' request.
1102
+ message UpdateConversionWorkspaceRequest {
1103
+ // Required. Field mask is used to specify the fields to be overwritten by the
1104
+ // update in the conversion workspace resource.
1105
+ google.protobuf.FieldMask update_mask = 1
1106
+ [(google.api.field_behavior) = REQUIRED];
1107
+
1108
+ // Required. The conversion workspace parameters to update.
1109
+ ConversionWorkspace conversion_workspace = 2
1110
+ [(google.api.field_behavior) = REQUIRED];
1111
+
1112
+ // A unique ID used to identify the request. If the server receives two
1113
+ // requests with the same ID, then the second request is ignored.
1114
+ //
1115
+ // It is recommended to always set this value to a UUID.
1116
+ //
1117
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1118
+ // (_), and hyphens (-). The maximum length is 40 characters.
1119
+ string request_id = 3;
1120
+ }
1121
+
1122
+ // Request message for 'DeleteConversionWorkspace' request.
1123
+ message DeleteConversionWorkspaceRequest {
1124
+ // Required. Name of the conversion workspace resource to delete.
1125
+ string name = 1 [
1126
+ (google.api.field_behavior) = REQUIRED,
1127
+ (google.api.resource_reference) = {
1128
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1129
+ }
1130
+ ];
1131
+
1132
+ // A unique ID used to identify the request. If the server receives two
1133
+ // requests with the same ID, then the second request is ignored.
1134
+ //
1135
+ // It is recommended to always set this value to a UUID.
1136
+ //
1137
+ // The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1138
+ // (_), and hyphens (-). The maximum length is 40 characters.
1139
+ string request_id = 2;
1140
+ }
1141
+
1142
+ // Request message for 'CommitConversionWorkspace' request.
1143
+ message CommitConversionWorkspaceRequest {
1144
+ // Required. Name of the conversion workspace resource to commit.
1145
+ string name = 1 [
1146
+ (google.api.field_behavior) = REQUIRED,
1147
+ (google.api.resource_reference) = {
1148
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1149
+ }
1150
+ ];
1151
+
1152
+ // Optional. Optional name of the commit.
1153
+ string commit_name = 2 [(google.api.field_behavior) = OPTIONAL];
1154
+ }
1155
+
1156
+ // Request message for 'RollbackConversionWorkspace' request.
1157
+ message RollbackConversionWorkspaceRequest {
1158
+ // Required. Name of the conversion workspace resource to roll back to.
1159
+ string name = 1 [
1160
+ (google.api.field_behavior) = REQUIRED,
1161
+ (google.api.resource_reference) = {
1162
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1163
+ }
1164
+ ];
1165
+ }
1166
+
1167
+ // Request message for 'ApplyConversionWorkspace' request.
1168
+ message ApplyConversionWorkspaceRequest {
1169
+ // Required. The name of the conversion workspace resource for which to apply
1170
+ // the draft tree. Must be in the form of:
1171
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1172
+ string name = 1 [
1173
+ (google.api.field_behavior) = REQUIRED,
1174
+ (google.api.resource_reference) = {
1175
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1176
+ }
1177
+ ];
1178
+
1179
+ // Filter which entities to apply. Leaving this field empty will apply all of
1180
+ // the entities. Supports Google AIP 160 based filtering.
1181
+ string filter = 2;
1182
+
1183
+ // Which destination to use when applying the conversion workspace.
1184
+ oneof destination {
1185
+ // Fully qualified (Uri) name of the destination connection profile.
1186
+ string connection_profile = 100;
1187
+ }
1188
+ }
1189
+
1190
+ // Request message for 'SeedConversionWorkspace' request.
1191
+ message SeedConversionWorkspaceRequest {
1192
+ // Name of the conversion workspace resource to seed with new database
1193
+ // structure, in the form of:
1194
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1195
+ string name = 1 [(google.api.resource_reference) = {
1196
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1197
+ }];
1198
+
1199
+ // Should the conversion workspace be committed automatically after the
1200
+ // seed operation.
1201
+ bool auto_commit = 2;
1202
+
1203
+ // The input to be used for seeding the conversion workspace. The input can
1204
+ // either be from the source or destination databases and it can be provided
1205
+ // through a connection profile or a DDL file.
1206
+ oneof seed_from {
1207
+ // Fully qualified (Uri) name of the source connection profile.
1208
+ string source_connection_profile = 100;
1209
+
1210
+ // Fully qualified (Uri) name of the destination connection profile.
1211
+ string destination_connection_profile = 101;
1212
+ }
1213
+ }
1214
+
1215
+ // Request message for 'ConvertConversionWorkspace' request.
1216
+ message ConvertConversionWorkspaceRequest {
1217
+ // Name of the conversion workspace resource to convert in the form of:
1218
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1219
+ string name = 1 [(google.api.resource_reference) = {
1220
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1221
+ }];
1222
+
1223
+ // Specifies whether the conversion workspace is to be committed automatically
1224
+ // after the conversion.
1225
+ bool auto_commit = 4;
1226
+
1227
+ // Filter the entities to convert. Leaving this field empty will convert all
1228
+ // of the entities. Supports Google AIP-160 style filtering.
1229
+ string filter = 5;
1230
+ }
1231
+
1232
+ // Request message for 'ImportMappingRules' request.
1233
+ message ImportMappingRulesRequest {
1234
+ // Details of a single rules file.
1235
+ message RulesFile {
1236
+ // The filename of the rules that needs to be converted. The filename is
1237
+ // used mainly so that future logs of the import rules job contain it, and
1238
+ // can therefore be searched by it.
1239
+ string rules_source_filename = 1;
1240
+
1241
+ // The text content of the rules that needs to be converted.
1242
+ string rules_content = 2;
1243
+ }
1244
+
1245
+ // Required. Name of the conversion workspace resource to import the rules to
1246
+ // in the form of:
1247
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1248
+ string parent = 1 [
1249
+ (google.api.field_behavior) = REQUIRED,
1250
+ (google.api.resource_reference) = {
1251
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1252
+ }
1253
+ ];
1254
+
1255
+ // The format of the rules content file.
1256
+ ImportRulesFileFormat rules_format = 2;
1257
+
1258
+ // One or more rules files.
1259
+ repeated RulesFile rules_files = 3;
1260
+
1261
+ // Should the conversion workspace be committed automatically after the
1262
+ // import operation.
1263
+ bool auto_commit = 6;
1264
+ }
1265
+
1266
+ // Request message for 'DescribeDatabaseEntities' request.
1267
+ message DescribeDatabaseEntitiesRequest {
1268
+ // The type of a tree to return
1269
+ enum DBTreeType {
1270
+ // Unspecified tree type.
1271
+ DB_TREE_TYPE_UNSPECIFIED = 0;
1272
+
1273
+ // The source database tree.
1274
+ SOURCE_TREE = 1;
1275
+
1276
+ // The draft database tree.
1277
+ DRAFT_TREE = 2;
1278
+
1279
+ // The destination database tree.
1280
+ DESTINATION_TREE = 3;
1281
+ }
1282
+
1283
+ // Required. Name of the conversion workspace resource whose database entities
1284
+ // are described. Must be in the form of:
1285
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1286
+ string conversion_workspace = 1 [
1287
+ (google.api.field_behavior) = REQUIRED,
1288
+ (google.api.resource_reference) = {
1289
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1290
+ }
1291
+ ];
1292
+
1293
+ // The maximum number of entities to return. The service may return
1294
+ // fewer entities than the value specifies.
1295
+ int32 page_size = 3;
1296
+
1297
+ // The nextPageToken value received in the previous call to
1298
+ // conversionWorkspace.describeDatabaseEntities, used in the subsequent
1299
+ // request to retrieve the next page of results. On first call this should be
1300
+ // left blank. When paginating, all other parameters provided to
1301
+ // conversionWorkspace.describeDatabaseEntities must match the call that
1302
+ // provided the page token.
1303
+ string page_token = 4;
1304
+
1305
+ // The tree to fetch.
1306
+ DBTreeType tree = 6;
1307
+
1308
+ // Whether to retrieve the latest committed version of the entities or the
1309
+ // latest version. This field is ignored if a specific commit_id is specified.
1310
+ bool uncommitted = 11;
1311
+
1312
+ // Request a specific commit ID. If not specified, the entities from the
1313
+ // latest commit are returned.
1314
+ string commit_id = 12;
1315
+
1316
+ // Filter the returned entities based on AIP-160 standard.
1317
+ string filter = 13;
1318
+ }
1319
+
1320
+ // Response message for 'DescribeDatabaseEntities' request.
1321
+ message DescribeDatabaseEntitiesResponse {
1322
+ // The list of database entities for the conversion workspace.
1323
+ repeated DatabaseEntity database_entities = 1;
1324
+
1325
+ // A token which can be sent as `page_token` to retrieve the next page.
1326
+ // If this field is omitted, there are no subsequent pages.
1327
+ string next_page_token = 2;
1328
+ }
1329
+
1330
+ // Request message for 'SearchBackgroundJobs' request.
1331
+ message SearchBackgroundJobsRequest {
1332
+ // Required. Name of the conversion workspace resource whose jobs are listed,
1333
+ // in the form of:
1334
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1335
+ string conversion_workspace = 1 [
1336
+ (google.api.field_behavior) = REQUIRED,
1337
+ (google.api.resource_reference) = {
1338
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1339
+ }
1340
+ ];
1341
+
1342
+ // Optional. Whether or not to return just the most recent job per job type,
1343
+ bool return_most_recent_per_job_type = 2
1344
+ [(google.api.field_behavior) = OPTIONAL];
1345
+
1346
+ // Optional. The maximum number of jobs to return. The service may return
1347
+ // fewer than this value. If unspecified, at most 100 jobs are
1348
+ // returned. The maximum value is 100; values above 100 are coerced to
1349
+ // 100.
1350
+ int32 max_size = 3 [(google.api.field_behavior) = OPTIONAL];
1351
+
1352
+ // Optional. If provided, only returns jobs that completed until (not
1353
+ // including) the given timestamp.
1354
+ google.protobuf.Timestamp completed_until_time = 4
1355
+ [(google.api.field_behavior) = OPTIONAL];
1356
+ }
1357
+
1358
+ // Response message for 'SearchBackgroundJobs' request.
1359
+ message SearchBackgroundJobsResponse {
1360
+ // The list of conversion workspace mapping rules.
1361
+ repeated BackgroundJobLogEntry jobs = 1;
1362
+ }
1363
+
1364
+ // Request message for 'DescribeConversionWorkspaceRevisions' request.
1365
+ message DescribeConversionWorkspaceRevisionsRequest {
1366
+ // Required. Name of the conversion workspace resource whose revisions are
1367
+ // listed. Must be in the form of:
1368
+ // projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
1369
+ string conversion_workspace = 1 [
1370
+ (google.api.field_behavior) = REQUIRED,
1371
+ (google.api.resource_reference) = {
1372
+ type: "datamigration.googleapis.com/ConversionWorkspace"
1373
+ }
1374
+ ];
1375
+
1376
+ // Optional. Optional filter to request a specific commit ID.
1377
+ string commit_id = 2 [(google.api.field_behavior) = OPTIONAL];
1378
+ }
1379
+
1380
+ // Response message for 'DescribeConversionWorkspaceRevisions' request.
1381
+ message DescribeConversionWorkspaceRevisionsResponse {
1382
+ // The list of conversion workspace revisions.
1383
+ repeated ConversionWorkspace revisions = 1;
1384
+ }
1385
+
1386
+ // Request message for 'FetchStaticIps' request.
1387
+ message FetchStaticIpsRequest {
1388
+ // Required. The resource name for the location for which static IPs should be
1389
+ // returned. Must be in the format `projects/*/locations/*`.
1390
+ string name = 1 [
1391
+ (google.api.field_behavior) = REQUIRED,
1392
+ (google.api.resource_reference) = {
1393
+ type: "locations.googleapis.com/Location"
1394
+ }
1395
+ ];
1396
+
1397
+ // Maximum number of IPs to return.
1398
+ int32 page_size = 2;
1399
+
1400
+ // A page token, received from a previous `FetchStaticIps` call.
1401
+ string page_token = 3;
1402
+ }
1403
+
1404
+ // Response message for a 'FetchStaticIps' request.
1405
+ message FetchStaticIpsResponse {
1406
+ // List of static IPs.
1407
+ repeated string static_ips = 1;
1408
+
1409
+ // A token that can be sent as `page_token` to retrieve the next page.
1410
+ // If this field is omitted, there are no subsequent pages.
1411
+ string next_page_token = 2;
1412
+ }