Skip to content

Commit d8afe7c

Browse files
feat(vmmigration): update the api
#### vmmigration:v1alpha1 The following keys were added: - resources.projects.resources.locations.resources.sources.resources.migratingVms.methods.get.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.sources.resources.migratingVms.methods.list.parameters.view (Total Keys: 2)
1 parent 25c091e commit d8afe7c

File tree

2 files changed

+55
-15
lines changed

2 files changed

+55
-15
lines changed

docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ <h2>Instance Methods</h2>
9797
<code><a href="#finalizeMigration">finalizeMigration(migratingVm, body=None, x__xgafv=None)</a></code></p>
9898
<p class="firstline">Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.</p>
9999
<p class="toc_element">
100-
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
100+
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
101101
<p class="firstline">Gets details of a single MigratingVm.</p>
102102
<p class="toc_element">
103-
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
103+
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
104104
<p class="firstline">Lists MigratingVms in a given Source.</p>
105105
<p class="toc_element">
106106
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -263,7 +263,7 @@ <h3>Method Details</h3>
263263
&quot;idleDuration&quot;: &quot;A String&quot;, # The idle duration between replication stages.
264264
&quot;skipOsAdaptation&quot;: True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM&#x27;s operating system undergoes changes and adaptations to fully function on Compute Engine.
265265
},
266-
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists.
266+
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
267267
{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.
268268
&quot;computeEngineTargetDetails&quot;: { # 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.
269269
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -434,7 +434,7 @@ <h3>Method Details</h3>
434434
},
435435
},
436436
],
437-
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists.
437+
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
438438
{ # 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.
439439
&quot;computeEngineTargetDetails&quot;: { # 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.
440440
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -775,11 +775,16 @@ <h3>Method Details</h3>
775775
</div>
776776

777777
<div class="method">
778-
<code class="details" id="get">get(name, x__xgafv=None)</code>
778+
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
779779
<pre>Gets details of a single MigratingVm.
780780

781781
Args:
782782
name: string, Required. The name of the MigratingVm. (required)
783+
view: string, Optional. The level of details of the migrating VM.
784+
Allowed values
785+
MIGRATING_VM_VIEW_UNSPECIFIED - The default / unset value. Will fallback to FULL.
786+
MIGRATING_VM_VIEW_BASIC - Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.
787+
MIGRATING_VM_VIEW_FULL - Include everything.
783788
x__xgafv: string, V1 error format.
784789
Allowed values
785790
1 - v1 error format
@@ -919,7 +924,7 @@ <h3>Method Details</h3>
919924
&quot;idleDuration&quot;: &quot;A String&quot;, # The idle duration between replication stages.
920925
&quot;skipOsAdaptation&quot;: True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM&#x27;s operating system undergoes changes and adaptations to fully function on Compute Engine.
921926
},
922-
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists.
927+
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
923928
{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.
924929
&quot;computeEngineTargetDetails&quot;: { # 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.
925930
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -1090,7 +1095,7 @@ <h3>Method Details</h3>
10901095
},
10911096
},
10921097
],
1093-
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists.
1098+
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
10941099
{ # 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.
10951100
&quot;computeEngineTargetDetails&quot;: { # 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.
10961101
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -1325,7 +1330,7 @@ <h3>Method Details</h3>
13251330
</div>
13261331

13271332
<div class="method">
1328-
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
1333+
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
13291334
<pre>Lists MigratingVms in a given Source.
13301335

13311336
Args:
@@ -1334,6 +1339,11 @@ <h3>Method Details</h3>
13341339
orderBy: string, Optional. the order by fields for the result.
13351340
pageSize: integer, Optional. The maximum number of migrating VMs to return. The service may return fewer than this value. If unspecified, at most 500 migrating VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
13361341
pageToken: string, Required. A page token, received from a previous `ListMigratingVms` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMigratingVms` must match the call that provided the page token.
1342+
view: string, Optional. The level of details of each migrating VM.
1343+
Allowed values
1344+
MIGRATING_VM_VIEW_UNSPECIFIED - The default / unset value. Will fallback to FULL.
1345+
MIGRATING_VM_VIEW_BASIC - Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.
1346+
MIGRATING_VM_VIEW_FULL - Include everything.
13371347
x__xgafv: string, V1 error format.
13381348
Allowed values
13391349
1 - v1 error format
@@ -1475,7 +1485,7 @@ <h3>Method Details</h3>
14751485
&quot;idleDuration&quot;: &quot;A String&quot;, # The idle duration between replication stages.
14761486
&quot;skipOsAdaptation&quot;: True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM&#x27;s operating system undergoes changes and adaptations to fully function on Compute Engine.
14771487
},
1478-
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists.
1488+
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
14791489
{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.
14801490
&quot;computeEngineTargetDetails&quot;: { # 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.
14811491
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -1646,7 +1656,7 @@ <h3>Method Details</h3>
16461656
},
16471657
},
16481658
],
1649-
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists.
1659+
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
16501660
{ # 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.
16511661
&quot;computeEngineTargetDetails&quot;: { # 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.
16521662
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -2040,7 +2050,7 @@ <h3>Method Details</h3>
20402050
&quot;idleDuration&quot;: &quot;A String&quot;, # The idle duration between replication stages.
20412051
&quot;skipOsAdaptation&quot;: True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM&#x27;s operating system undergoes changes and adaptations to fully function on Compute Engine.
20422052
},
2043-
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists.
2053+
&quot;recentCloneJobs&quot;: [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm&#x27;s last completed clone job and the vm&#x27;s running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
20442054
{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.
20452055
&quot;computeEngineTargetDetails&quot;: { # 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.
20462056
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.
@@ -2211,7 +2221,7 @@ <h3>Method Details</h3>
22112221
},
22122222
},
22132223
],
2214-
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists.
2224+
&quot;recentCutoverJobs&quot;: [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm&#x27;s last completed cutover job and the vm&#x27;s running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the &quot;view&quot; parameter of the Get/List request.
22152225
{ # 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.
22162226
&quot;computeEngineTargetDetails&quot;: { # 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.
22172227
&quot;appliedLicense&quot;: { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report.

googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1001,6 +1001,21 @@
10011001
"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$",
10021002
"required": true,
10031003
"type": "string"
1004+
},
1005+
"view": {
1006+
"description": "Optional. The level of details of the migrating VM.",
1007+
"enum": [
1008+
"MIGRATING_VM_VIEW_UNSPECIFIED",
1009+
"MIGRATING_VM_VIEW_BASIC",
1010+
"MIGRATING_VM_VIEW_FULL"
1011+
],
1012+
"enumDescriptions": [
1013+
"The default / unset value. Will fallback to FULL.",
1014+
"Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.",
1015+
"Include everything."
1016+
],
1017+
"location": "query",
1018+
"type": "string"
10041019
}
10051020
},
10061021
"path": "v1alpha1/{+name}",
@@ -1047,6 +1062,21 @@
10471062
"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+$",
10481063
"required": true,
10491064
"type": "string"
1065+
},
1066+
"view": {
1067+
"description": "Optional. The level of details of each migrating VM.",
1068+
"enum": [
1069+
"MIGRATING_VM_VIEW_UNSPECIFIED",
1070+
"MIGRATING_VM_VIEW_BASIC",
1071+
"MIGRATING_VM_VIEW_FULL"
1072+
],
1073+
"enumDescriptions": [
1074+
"The default / unset value. Will fallback to FULL.",
1075+
"Get the migrating VM basic details. The basic details do not include the recent clone jobs and recent cutover jobs lists.",
1076+
"Include everything."
1077+
],
1078+
"location": "query",
1079+
"type": "string"
10501080
}
10511081
},
10521082
"path": "v1alpha1/{+parent}/migratingVms",
@@ -1828,7 +1858,7 @@
18281858
}
18291859
}
18301860
},
1831-
"revision": "20211014",
1861+
"revision": "20211021",
18321862
"rootUrl": "https://vmmigration.googleapis.com/",
18331863
"schemas": {
18341864
"AddGroupMigrationRequest": {
@@ -2842,15 +2872,15 @@
28422872
"description": "The replication schedule policy."
28432873
},
28442874
"recentCloneJobs": {
2845-
"description": "Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists.",
2875+
"description": "Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the \"view\" parameter of the Get/List request.",
28462876
"items": {
28472877
"$ref": "CloneJob"
28482878
},
28492879
"readOnly": true,
28502880
"type": "array"
28512881
},
28522882
"recentCutoverJobs": {
2853-
"description": "Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists.",
2883+
"description": "Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the \"view\" parameter of the Get/List request.",
28542884
"items": {
28552885
"$ref": "CutoverJob"
28562886
},

0 commit comments

Comments
 (0)