1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="vmmigration_v1alpha1.html">VM Migration API</a> . <a href="vmmigration_v1alpha1.projects.html">projects</a> . <a href="vmmigration_v1alpha1.projects.locations.html">locations</a> . <a href="vmmigration_v1alpha1.projects.locations.sources.html">sources</a> . <a href="vmmigration_v1alpha1.projects.locations.sources.migratingVms.html">migratingVms</a> . <a href="vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html">cutoverJobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Initiates the cancellation of a running cutover job.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, cutoverJobId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single CutoverJob.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists CutoverJobs of a given migrating VM.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Initiates the cancellation of a running cutover job.
Args:
name: string, Required. The cutover job id (required)
body: object, The request body.
The object takes the form of:
{ # Request message for 'CancelCutoverJob' request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, cutoverJobId=None, requestId=None, x__xgafv=None)</code>
<pre>Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.
Args:
parent: string, Required. The Cutover's parent. (required)
body: object, The request body.
The object takes the form of:
{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.
"computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # The GCP target project ID or project name.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"vmName": "A String", # The name of the VM to create.
"zone": "A String", # The zone in which to create the VM.
},
"computeEngineVmDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
"createTime": "A String", # Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details for the errors that led to the Cutover Job's state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # Output only. The name of the cutover job.
"progress": 42, # Output only. The current progress in percentage of the cutover job.
"progressPercent": 42, # Output only. The current progress in percentage of the cutover job.
"state": "A String", # Output only. State of the cutover job.
"stateMessage": "A String", # Output only. A message providing possible extra details about the current state.
"stateTime": "A String", # Output only. The time the state was last updated.
"targetDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
}
cutoverJobId: string, Required. The cutover job identifier.
requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single CutoverJob.
Args:
name: string, Required. The name of the CutoverJob. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.
"computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # The GCP target project ID or project name.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"vmName": "A String", # The name of the VM to create.
"zone": "A String", # The zone in which to create the VM.
},
"computeEngineVmDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
"createTime": "A String", # Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details for the errors that led to the Cutover Job's state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # Output only. The name of the cutover job.
"progress": 42, # Output only. The current progress in percentage of the cutover job.
"progressPercent": 42, # Output only. The current progress in percentage of the cutover job.
"state": "A String", # Output only. State of the cutover job.
"stateMessage": "A String", # Output only. A message providing possible extra details about the current state.
"stateTime": "A String", # Output only. The time the state was last updated.
"targetDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists CutoverJobs of a given migrating VM.
Args:
parent: string, Required. The parent, which owns this collection of migrating VMs. (required)
filter: string, Optional. The filter request.
orderBy: string, Optional. the order by fields for the result.
pageSize: integer, Optional. The maximum number of cutover jobs to return. The service may return fewer than this value. If unspecified, at most 500 cutover jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Required. A page token, received from a previous `ListCutoverJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCutoverJobs` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for 'ListCutoverJobs' request.
"cutoverJobs": [ # Output only. The list of cutover jobs response.
{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.
"computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # The GCP target project ID or project name.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"vmName": "A String", # The name of the VM to create.
"zone": "A String", # The zone in which to create the VM.
},
"computeEngineVmDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
"createTime": "A String", # Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details for the errors that led to the Cutover Job's state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # Output only. The name of the cutover job.
"progress": 42, # Output only. The current progress in percentage of the cutover job.
"progressPercent": 42, # Output only. The current progress in percentage of the cutover job.
"state": "A String", # Output only. State of the cutover job.
"stateMessage": "A String", # Output only. A message providing possible extra details about the current state.
"stateTime": "A String", # Output only. The time the state was last updated.
"targetDetails": { # TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use compute_engine_target_details instead.
"appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report.
"osLicense": "A String", # The OS license returned from the adaptation module's report.
"type": "A String", # The license type that was used in OS adaptation.
},
"bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm.
"computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used).
"automaticRestart": True or False,
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes.
{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. Based on https://cloud.google.com/compute/docs/reference/rest/v1/instances/setScheduling
"key": "A String", # The label key of Node resource to reference.
"operator": "A String", # The operator to use for the node resources specified in the `values` parameter.
"values": [ # Corresponds to the label values of Node resource.
"A String",
],
},
],
"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.
},
"diskType": "A String", # The disk type to use in the VM.
"externalIp": "A String", # The external IP to define in the VM.
"internalIp": "A String", # The internal IP to define in the VM. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"labels": { # A map of labels to associate with the VM.
"a_key": "A String",
},
"licenseType": "A String", # The license type to use in OS adaptation.
"machineType": "A String", # The machine type to create the VM with.
"machineTypeSeries": "A String", # The machine type series to create the VM with.
"metadata": { # The metadata key/value pairs to assign to the VM.
"a_key": "A String",
},
"name": "A String", # The name of the VM to create.
"network": "A String", # The network to connect the VM to.
"networkInterfaces": [ # List of NICs connected to this VM.
{ # NetworkInterface represents a NIC of a VM.
"externalIp": "A String", # The external IP to define in the NIC.
"internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path.
"network": "A String", # The network to connect the NIC to.
"subnetwork": "A String", # The subnetwork to connect the NIC to.
},
],
"networkTags": [ # A map of network tags to associate with the VM.
"A String",
],
"project": "A String", # Output only. The project in which to create the VM.
"secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.
"serviceAccount": "A String", # The service account to associate the VM with.
"subnetwork": "A String", # The subnetwork to connect the VM to.
"targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
"zone": "A String", # The zone in which to create the VM.
},
},
],
"nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Output only. Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
