| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="vmmigration_v1.html">VM Migration API</a> . <a href="vmmigration_v1.projects.html">projects</a> . <a href="vmmigration_v1.projects.locations.html">locations</a> . <a href="vmmigration_v1.projects.locations.sources.html">sources</a> . <a href="vmmigration_v1.projects.locations.sources.migratingVms.html">migratingVms</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html">cloneJobs()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the cloneJobs Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html">cutoverJobs()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the cutoverJobs Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="#close">close()</a></code></p> |
| 89 | <p class="firstline">Close httplib2 connections.</p> |
| 90 | <p class="toc_element"> |
| 91 | <code><a href="#create">create(parent, body=None, migratingVmId=None, requestId=None, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Creates a new MigratingVm in a given Source.</p> |
| 93 | <p class="toc_element"> |
| 94 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Deletes a single MigratingVm.</p> |
| 96 | <p class="toc_element"> |
| 97 | <code><a href="#finalizeMigration">finalizeMigration(migratingVm, body=None, x__xgafv=None)</a></code></p> |
| 98 | <p class="firstline">Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.</p> |
| 99 | <p class="toc_element"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 100 | <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 101 | <p class="firstline">Gets details of a single MigratingVm.</p> |
| 102 | <p class="toc_element"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 103 | <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 104 | <p class="firstline">Lists MigratingVms in a given Source.</p> |
| 105 | <p class="toc_element"> |
| 106 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 107 | <p class="firstline">Retrieves the next page of results.</p> |
| 108 | <p class="toc_element"> |
| 109 | <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 110 | <p class="firstline">Updates the parameters of a single MigratingVm.</p> |
| 111 | <p class="toc_element"> |
| 112 | <code><a href="#pauseMigration">pauseMigration(migratingVm, body=None, x__xgafv=None)</a></code></p> |
| 113 | <p class="firstline">Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.</p> |
| 114 | <p class="toc_element"> |
| 115 | <code><a href="#resumeMigration">resumeMigration(migratingVm, body=None, x__xgafv=None)</a></code></p> |
| 116 | <p class="firstline">Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.</p> |
| 117 | <p class="toc_element"> |
| 118 | <code><a href="#startMigration">startMigration(migratingVm, body=None, x__xgafv=None)</a></code></p> |
| 119 | <p class="firstline">Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.</p> |
| 120 | <h3>Method Details</h3> |
| 121 | <div class="method"> |
| 122 | <code class="details" id="close">close()</code> |
| 123 | <pre>Close httplib2 connections.</pre> |
| 124 | </div> |
| 125 | |
| 126 | <div class="method"> |
| 127 | <code class="details" id="create">create(parent, body=None, migratingVmId=None, requestId=None, x__xgafv=None)</code> |
| 128 | <pre>Creates a new MigratingVm in a given Source. |
| 129 | |
| 130 | Args: |
| 131 | parent: string, Required. The MigratingVm's parent. (required) |
| 132 | body: object, The request body. |
| 133 | The object takes the form of: |
| 134 | |
| 135 | { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. |
| 136 | "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 137 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 138 | "A String", |
| 139 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 140 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. |
| 141 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 142 | "type": "A String", # The license type that was used in OS adaptation. |
| 143 | }, |
| 144 | "bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm. |
| 145 | "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). |
| 146 | "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. |
| 147 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 148 | { # 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 |
| 149 | "key": "A String", # The label key of Node resource to reference. |
| 150 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 151 | "values": [ # Corresponds to the label values of Node resource. |
| 152 | "A String", |
| 153 | ], |
| 154 | }, |
| 155 | ], |
| 156 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 157 | "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. |
| 158 | }, |
| 159 | "diskType": "A String", # The disk type to use in the VM. |
| 160 | "labels": { # A map of labels to associate with the VM. |
| 161 | "a_key": "A String", |
| 162 | }, |
| 163 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 164 | "machineType": "A String", # The machine type to create the VM with. |
| 165 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 166 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 167 | "a_key": "A String", |
| 168 | }, |
| 169 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 170 | { # NetworkInterface represents a NIC of a VM. |
| 171 | "externalIp": "A String", # The external IP to define in the NIC. |
| 172 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 173 | "network": "A String", # The network to connect the NIC to. |
| 174 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 175 | }, |
| 176 | ], |
| 177 | "networkTags": [ # A map of network tags to associate with the VM. |
| 178 | "A String", |
| 179 | ], |
| 180 | "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. |
| 181 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 182 | "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. |
| 183 | "vmName": "A String", # The name of the VM to create. |
| 184 | "zone": "A String", # The zone in which to create the VM. |
| 185 | }, |
| 186 | "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). |
| 187 | "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. |
| 188 | "progressPercent": 42, # The current progress in percentage of this cycle. |
| 189 | "startTime": "A String", # The time the replication cycle has started. |
| 190 | }, |
| 191 | "description": "A String", # The description attached to the migrating VM by the user. |
| 192 | "displayName": "A String", # The display name attached to the MigratingVm by the user. |
| 193 | "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 on the state of the Migrating VM in case of an error in replication. |
| 194 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 195 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 196 | { |
| 197 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 198 | }, |
| 199 | ], |
| 200 | "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. |
| 201 | }, |
| 202 | "group": "A String", # Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. |
| 203 | "labels": { # The labels of the migrating VM. |
| 204 | "a_key": "A String", |
| 205 | }, |
| 206 | "lastSync": { # ReplicationSync contain information about the last replica sync to the cloud. # Output only. The most updated snapshot created time in the source that finished replication. |
| 207 | "lastSyncTime": "A String", # The most updated snapshot created time in the source that finished replication. |
| 208 | }, |
| 209 | "name": "A String", # Output only. The identifier of the MigratingVm. |
| 210 | "policy": { # A policy for scheduling replications. # The replication schedule policy. |
| 211 | "idleDuration": "A String", # The idle duration between replication stages. |
| 212 | "skipOsAdaptation": True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine. |
| 213 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 214 | "recentCloneJobs": [ # 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. |
| 215 | { # 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. |
| 216 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 217 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 218 | "A String", |
| 219 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 220 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 221 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 222 | "type": "A String", # The license type that was used in OS adaptation. |
| 223 | }, |
| 224 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 225 | "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). |
| 226 | "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. |
| 227 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 228 | { # 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 |
| 229 | "key": "A String", # The label key of Node resource to reference. |
| 230 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 231 | "values": [ # Corresponds to the label values of Node resource. |
| 232 | "A String", |
| 233 | ], |
| 234 | }, |
| 235 | ], |
| 236 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 237 | "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. |
| 238 | }, |
| 239 | "diskType": "A String", # The disk type to use in the VM. |
| 240 | "labels": { # A map of labels to associate with the VM. |
| 241 | "a_key": "A String", |
| 242 | }, |
| 243 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 244 | "machineType": "A String", # The machine type to create the VM with. |
| 245 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 246 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 247 | "a_key": "A String", |
| 248 | }, |
| 249 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 250 | { # NetworkInterface represents a NIC of a VM. |
| 251 | "externalIp": "A String", # The external IP to define in the NIC. |
| 252 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 253 | "network": "A String", # The network to connect the NIC to. |
| 254 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 255 | }, |
| 256 | ], |
| 257 | "networkTags": [ # A map of network tags to associate with the VM. |
| 258 | "A String", |
| 259 | ], |
| 260 | "project": "A String", # The GCP target project ID or project name. |
| 261 | "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. |
| 262 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 263 | "vmName": "A String", # The name of the VM to create. |
| 264 | "zone": "A String", # The zone in which to create the VM. |
| 265 | }, |
| 266 | "createTime": "A String", # Output only. The time the clone job was created (as an API call, not when it was actually created in the target). |
| 267 | "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 Clone Job's state. |
| 268 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 269 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 270 | { |
| 271 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 272 | }, |
| 273 | ], |
| 274 | "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. |
| 275 | }, |
| 276 | "name": "A String", # The name of the clone. |
| 277 | "state": "A String", # Output only. State of the clone job. |
| 278 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 279 | }, |
| 280 | ], |
| 281 | "recentCutoverJobs": [ # 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. |
| 282 | { # 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. |
| 283 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 284 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 285 | "A String", |
| 286 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 287 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 288 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 289 | "type": "A String", # The license type that was used in OS adaptation. |
| 290 | }, |
| 291 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 292 | "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). |
| 293 | "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. |
| 294 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 295 | { # 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 |
| 296 | "key": "A String", # The label key of Node resource to reference. |
| 297 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 298 | "values": [ # Corresponds to the label values of Node resource. |
| 299 | "A String", |
| 300 | ], |
| 301 | }, |
| 302 | ], |
| 303 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 304 | "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. |
| 305 | }, |
| 306 | "diskType": "A String", # The disk type to use in the VM. |
| 307 | "labels": { # A map of labels to associate with the VM. |
| 308 | "a_key": "A String", |
| 309 | }, |
| 310 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 311 | "machineType": "A String", # The machine type to create the VM with. |
| 312 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 313 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 314 | "a_key": "A String", |
| 315 | }, |
| 316 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 317 | { # NetworkInterface represents a NIC of a VM. |
| 318 | "externalIp": "A String", # The external IP to define in the NIC. |
| 319 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 320 | "network": "A String", # The network to connect the NIC to. |
| 321 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 322 | }, |
| 323 | ], |
| 324 | "networkTags": [ # A map of network tags to associate with the VM. |
| 325 | "A String", |
| 326 | ], |
| 327 | "project": "A String", # The GCP target project ID or project name. |
| 328 | "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. |
| 329 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 330 | "vmName": "A String", # The name of the VM to create. |
| 331 | "zone": "A String", # The zone in which to create the VM. |
| 332 | }, |
| 333 | "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). |
| 334 | "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. |
| 335 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 336 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 337 | { |
| 338 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 339 | }, |
| 340 | ], |
| 341 | "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. |
| 342 | }, |
| 343 | "name": "A String", # Output only. The name of the cutover job. |
| 344 | "progressPercent": 42, # Output only. The current progress in percentage of the cutover job. |
| 345 | "state": "A String", # Output only. State of the cutover job. |
| 346 | "stateMessage": "A String", # Output only. A message providing possible extra details about the current state. |
| 347 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 348 | }, |
| 349 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 350 | "sourceVmId": "A String", # The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. |
| 351 | "state": "A String", # Output only. State of the MigratingVm. |
| 352 | "stateTime": "A String", # Output only. The last time the migrating VM state was updated. |
| 353 | "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. |
| 354 | } |
| 355 | |
| 356 | migratingVmId: string, Required. The migratingVm identifier. |
| 357 | 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). |
| 358 | x__xgafv: string, V1 error format. |
| 359 | Allowed values |
| 360 | 1 - v1 error format |
| 361 | 2 - v2 error format |
| 362 | |
| 363 | Returns: |
| 364 | An object of the form: |
| 365 | |
| 366 | { # This resource represents a long-running operation that is the result of a network API call. |
| 367 | "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. |
| 368 | "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. |
| 369 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 370 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 371 | { |
| 372 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 373 | }, |
| 374 | ], |
| 375 | "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. |
| 376 | }, |
| 377 | "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. |
| 378 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 379 | }, |
| 380 | "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}`. |
| 381 | "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`. |
| 382 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 383 | }, |
| 384 | }</pre> |
| 385 | </div> |
| 386 | |
| 387 | <div class="method"> |
| 388 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 389 | <pre>Deletes a single MigratingVm. |
| 390 | |
| 391 | Args: |
| 392 | name: string, Required. The name of the MigratingVm. (required) |
| 393 | x__xgafv: string, V1 error format. |
| 394 | Allowed values |
| 395 | 1 - v1 error format |
| 396 | 2 - v2 error format |
| 397 | |
| 398 | Returns: |
| 399 | An object of the form: |
| 400 | |
| 401 | { # This resource represents a long-running operation that is the result of a network API call. |
| 402 | "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. |
| 403 | "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. |
| 404 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 405 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 406 | { |
| 407 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 408 | }, |
| 409 | ], |
| 410 | "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. |
| 411 | }, |
| 412 | "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. |
| 413 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 414 | }, |
| 415 | "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}`. |
| 416 | "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`. |
| 417 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 418 | }, |
| 419 | }</pre> |
| 420 | </div> |
| 421 | |
| 422 | <div class="method"> |
| 423 | <code class="details" id="finalizeMigration">finalizeMigration(migratingVm, body=None, x__xgafv=None)</code> |
| 424 | <pre>Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done. |
| 425 | |
| 426 | Args: |
| 427 | migratingVm: string, Required. The name of the MigratingVm. (required) |
| 428 | body: object, The request body. |
| 429 | The object takes the form of: |
| 430 | |
| 431 | { # Request message for 'FinalizeMigration' request. |
| 432 | } |
| 433 | |
| 434 | x__xgafv: string, V1 error format. |
| 435 | Allowed values |
| 436 | 1 - v1 error format |
| 437 | 2 - v2 error format |
| 438 | |
| 439 | Returns: |
| 440 | An object of the form: |
| 441 | |
| 442 | { # This resource represents a long-running operation that is the result of a network API call. |
| 443 | "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. |
| 444 | "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. |
| 445 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 446 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 447 | { |
| 448 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 449 | }, |
| 450 | ], |
| 451 | "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. |
| 452 | }, |
| 453 | "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. |
| 454 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 455 | }, |
| 456 | "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}`. |
| 457 | "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`. |
| 458 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 459 | }, |
| 460 | }</pre> |
| 461 | </div> |
| 462 | |
| 463 | <div class="method"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 464 | <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 465 | <pre>Gets details of a single MigratingVm. |
| 466 | |
| 467 | Args: |
| 468 | name: string, Required. The name of the MigratingVm. (required) |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 469 | view: string, Optional. The level of details of the migrating VM. |
| 470 | Allowed values |
| 471 | MIGRATING_VM_VIEW_UNSPECIFIED - View is unspecified. The API will fallback to the default value. |
| 472 | 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. |
| 473 | MIGRATING_VM_VIEW_FULL - Include everything. |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 474 | x__xgafv: string, V1 error format. |
| 475 | Allowed values |
| 476 | 1 - v1 error format |
| 477 | 2 - v2 error format |
| 478 | |
| 479 | Returns: |
| 480 | An object of the form: |
| 481 | |
| 482 | { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. |
| 483 | "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 484 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 485 | "A String", |
| 486 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 487 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. |
| 488 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 489 | "type": "A String", # The license type that was used in OS adaptation. |
| 490 | }, |
| 491 | "bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm. |
| 492 | "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). |
| 493 | "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. |
| 494 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 495 | { # 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 |
| 496 | "key": "A String", # The label key of Node resource to reference. |
| 497 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 498 | "values": [ # Corresponds to the label values of Node resource. |
| 499 | "A String", |
| 500 | ], |
| 501 | }, |
| 502 | ], |
| 503 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 504 | "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. |
| 505 | }, |
| 506 | "diskType": "A String", # The disk type to use in the VM. |
| 507 | "labels": { # A map of labels to associate with the VM. |
| 508 | "a_key": "A String", |
| 509 | }, |
| 510 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 511 | "machineType": "A String", # The machine type to create the VM with. |
| 512 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 513 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 514 | "a_key": "A String", |
| 515 | }, |
| 516 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 517 | { # NetworkInterface represents a NIC of a VM. |
| 518 | "externalIp": "A String", # The external IP to define in the NIC. |
| 519 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 520 | "network": "A String", # The network to connect the NIC to. |
| 521 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 522 | }, |
| 523 | ], |
| 524 | "networkTags": [ # A map of network tags to associate with the VM. |
| 525 | "A String", |
| 526 | ], |
| 527 | "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. |
| 528 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 529 | "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. |
| 530 | "vmName": "A String", # The name of the VM to create. |
| 531 | "zone": "A String", # The zone in which to create the VM. |
| 532 | }, |
| 533 | "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). |
| 534 | "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. |
| 535 | "progressPercent": 42, # The current progress in percentage of this cycle. |
| 536 | "startTime": "A String", # The time the replication cycle has started. |
| 537 | }, |
| 538 | "description": "A String", # The description attached to the migrating VM by the user. |
| 539 | "displayName": "A String", # The display name attached to the MigratingVm by the user. |
| 540 | "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 on the state of the Migrating VM in case of an error in replication. |
| 541 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 542 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 543 | { |
| 544 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 545 | }, |
| 546 | ], |
| 547 | "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. |
| 548 | }, |
| 549 | "group": "A String", # Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. |
| 550 | "labels": { # The labels of the migrating VM. |
| 551 | "a_key": "A String", |
| 552 | }, |
| 553 | "lastSync": { # ReplicationSync contain information about the last replica sync to the cloud. # Output only. The most updated snapshot created time in the source that finished replication. |
| 554 | "lastSyncTime": "A String", # The most updated snapshot created time in the source that finished replication. |
| 555 | }, |
| 556 | "name": "A String", # Output only. The identifier of the MigratingVm. |
| 557 | "policy": { # A policy for scheduling replications. # The replication schedule policy. |
| 558 | "idleDuration": "A String", # The idle duration between replication stages. |
| 559 | "skipOsAdaptation": True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine. |
| 560 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 561 | "recentCloneJobs": [ # 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. |
| 562 | { # 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. |
| 563 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 564 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 565 | "A String", |
| 566 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 567 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 568 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 569 | "type": "A String", # The license type that was used in OS adaptation. |
| 570 | }, |
| 571 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 572 | "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). |
| 573 | "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. |
| 574 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 575 | { # 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 |
| 576 | "key": "A String", # The label key of Node resource to reference. |
| 577 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 578 | "values": [ # Corresponds to the label values of Node resource. |
| 579 | "A String", |
| 580 | ], |
| 581 | }, |
| 582 | ], |
| 583 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 584 | "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. |
| 585 | }, |
| 586 | "diskType": "A String", # The disk type to use in the VM. |
| 587 | "labels": { # A map of labels to associate with the VM. |
| 588 | "a_key": "A String", |
| 589 | }, |
| 590 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 591 | "machineType": "A String", # The machine type to create the VM with. |
| 592 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 593 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 594 | "a_key": "A String", |
| 595 | }, |
| 596 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 597 | { # NetworkInterface represents a NIC of a VM. |
| 598 | "externalIp": "A String", # The external IP to define in the NIC. |
| 599 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 600 | "network": "A String", # The network to connect the NIC to. |
| 601 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 602 | }, |
| 603 | ], |
| 604 | "networkTags": [ # A map of network tags to associate with the VM. |
| 605 | "A String", |
| 606 | ], |
| 607 | "project": "A String", # The GCP target project ID or project name. |
| 608 | "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. |
| 609 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 610 | "vmName": "A String", # The name of the VM to create. |
| 611 | "zone": "A String", # The zone in which to create the VM. |
| 612 | }, |
| 613 | "createTime": "A String", # Output only. The time the clone job was created (as an API call, not when it was actually created in the target). |
| 614 | "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 Clone Job's state. |
| 615 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 616 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 617 | { |
| 618 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 619 | }, |
| 620 | ], |
| 621 | "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. |
| 622 | }, |
| 623 | "name": "A String", # The name of the clone. |
| 624 | "state": "A String", # Output only. State of the clone job. |
| 625 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 626 | }, |
| 627 | ], |
| 628 | "recentCutoverJobs": [ # 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. |
| 629 | { # 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. |
| 630 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 631 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 632 | "A String", |
| 633 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 634 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 635 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 636 | "type": "A String", # The license type that was used in OS adaptation. |
| 637 | }, |
| 638 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 639 | "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). |
| 640 | "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. |
| 641 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 642 | { # 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 |
| 643 | "key": "A String", # The label key of Node resource to reference. |
| 644 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 645 | "values": [ # Corresponds to the label values of Node resource. |
| 646 | "A String", |
| 647 | ], |
| 648 | }, |
| 649 | ], |
| 650 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 651 | "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. |
| 652 | }, |
| 653 | "diskType": "A String", # The disk type to use in the VM. |
| 654 | "labels": { # A map of labels to associate with the VM. |
| 655 | "a_key": "A String", |
| 656 | }, |
| 657 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 658 | "machineType": "A String", # The machine type to create the VM with. |
| 659 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 660 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 661 | "a_key": "A String", |
| 662 | }, |
| 663 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 664 | { # NetworkInterface represents a NIC of a VM. |
| 665 | "externalIp": "A String", # The external IP to define in the NIC. |
| 666 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 667 | "network": "A String", # The network to connect the NIC to. |
| 668 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 669 | }, |
| 670 | ], |
| 671 | "networkTags": [ # A map of network tags to associate with the VM. |
| 672 | "A String", |
| 673 | ], |
| 674 | "project": "A String", # The GCP target project ID or project name. |
| 675 | "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. |
| 676 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 677 | "vmName": "A String", # The name of the VM to create. |
| 678 | "zone": "A String", # The zone in which to create the VM. |
| 679 | }, |
| 680 | "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). |
| 681 | "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. |
| 682 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 683 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 684 | { |
| 685 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 686 | }, |
| 687 | ], |
| 688 | "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. |
| 689 | }, |
| 690 | "name": "A String", # Output only. The name of the cutover job. |
| 691 | "progressPercent": 42, # Output only. The current progress in percentage of the cutover job. |
| 692 | "state": "A String", # Output only. State of the cutover job. |
| 693 | "stateMessage": "A String", # Output only. A message providing possible extra details about the current state. |
| 694 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 695 | }, |
| 696 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 697 | "sourceVmId": "A String", # The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. |
| 698 | "state": "A String", # Output only. State of the MigratingVm. |
| 699 | "stateTime": "A String", # Output only. The last time the migrating VM state was updated. |
| 700 | "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. |
| 701 | }</pre> |
| 702 | </div> |
| 703 | |
| 704 | <div class="method"> |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 705 | <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 706 | <pre>Lists MigratingVms in a given Source. |
| 707 | |
| 708 | Args: |
| 709 | parent: string, Required. The parent, which owns this collection of MigratingVms. (required) |
| 710 | filter: string, Optional. The filter request. |
| 711 | orderBy: string, Optional. the order by fields for the result. |
| 712 | 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. |
| 713 | 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. |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 714 | view: string, Optional. The level of details of each migrating VM. |
| 715 | Allowed values |
| 716 | MIGRATING_VM_VIEW_UNSPECIFIED - View is unspecified. The API will fallback to the default value. |
| 717 | 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. |
| 718 | MIGRATING_VM_VIEW_FULL - Include everything. |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 719 | x__xgafv: string, V1 error format. |
| 720 | Allowed values |
| 721 | 1 - v1 error format |
| 722 | 2 - v2 error format |
| 723 | |
| 724 | Returns: |
| 725 | An object of the form: |
| 726 | |
| 727 | { # Response message for 'ListMigratingVms' request. |
| 728 | "migratingVms": [ # Output only. The list of Migrating VMs response. |
| 729 | { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. |
| 730 | "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 731 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 732 | "A String", |
| 733 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 734 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. |
| 735 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 736 | "type": "A String", # The license type that was used in OS adaptation. |
| 737 | }, |
| 738 | "bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm. |
| 739 | "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). |
| 740 | "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. |
| 741 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 742 | { # 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 |
| 743 | "key": "A String", # The label key of Node resource to reference. |
| 744 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 745 | "values": [ # Corresponds to the label values of Node resource. |
| 746 | "A String", |
| 747 | ], |
| 748 | }, |
| 749 | ], |
| 750 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 751 | "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. |
| 752 | }, |
| 753 | "diskType": "A String", # The disk type to use in the VM. |
| 754 | "labels": { # A map of labels to associate with the VM. |
| 755 | "a_key": "A String", |
| 756 | }, |
| 757 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 758 | "machineType": "A String", # The machine type to create the VM with. |
| 759 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 760 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 761 | "a_key": "A String", |
| 762 | }, |
| 763 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 764 | { # NetworkInterface represents a NIC of a VM. |
| 765 | "externalIp": "A String", # The external IP to define in the NIC. |
| 766 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 767 | "network": "A String", # The network to connect the NIC to. |
| 768 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 769 | }, |
| 770 | ], |
| 771 | "networkTags": [ # A map of network tags to associate with the VM. |
| 772 | "A String", |
| 773 | ], |
| 774 | "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. |
| 775 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 776 | "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. |
| 777 | "vmName": "A String", # The name of the VM to create. |
| 778 | "zone": "A String", # The zone in which to create the VM. |
| 779 | }, |
| 780 | "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). |
| 781 | "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. |
| 782 | "progressPercent": 42, # The current progress in percentage of this cycle. |
| 783 | "startTime": "A String", # The time the replication cycle has started. |
| 784 | }, |
| 785 | "description": "A String", # The description attached to the migrating VM by the user. |
| 786 | "displayName": "A String", # The display name attached to the MigratingVm by the user. |
| 787 | "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 on the state of the Migrating VM in case of an error in replication. |
| 788 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 789 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 790 | { |
| 791 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 792 | }, |
| 793 | ], |
| 794 | "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. |
| 795 | }, |
| 796 | "group": "A String", # Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. |
| 797 | "labels": { # The labels of the migrating VM. |
| 798 | "a_key": "A String", |
| 799 | }, |
| 800 | "lastSync": { # ReplicationSync contain information about the last replica sync to the cloud. # Output only. The most updated snapshot created time in the source that finished replication. |
| 801 | "lastSyncTime": "A String", # The most updated snapshot created time in the source that finished replication. |
| 802 | }, |
| 803 | "name": "A String", # Output only. The identifier of the MigratingVm. |
| 804 | "policy": { # A policy for scheduling replications. # The replication schedule policy. |
| 805 | "idleDuration": "A String", # The idle duration between replication stages. |
| 806 | "skipOsAdaptation": True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine. |
| 807 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 808 | "recentCloneJobs": [ # 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. |
| 809 | { # 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. |
| 810 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 811 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 812 | "A String", |
| 813 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 814 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 815 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 816 | "type": "A String", # The license type that was used in OS adaptation. |
| 817 | }, |
| 818 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 819 | "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). |
| 820 | "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. |
| 821 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 822 | { # 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 |
| 823 | "key": "A String", # The label key of Node resource to reference. |
| 824 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 825 | "values": [ # Corresponds to the label values of Node resource. |
| 826 | "A String", |
| 827 | ], |
| 828 | }, |
| 829 | ], |
| 830 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 831 | "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. |
| 832 | }, |
| 833 | "diskType": "A String", # The disk type to use in the VM. |
| 834 | "labels": { # A map of labels to associate with the VM. |
| 835 | "a_key": "A String", |
| 836 | }, |
| 837 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 838 | "machineType": "A String", # The machine type to create the VM with. |
| 839 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 840 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 841 | "a_key": "A String", |
| 842 | }, |
| 843 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 844 | { # NetworkInterface represents a NIC of a VM. |
| 845 | "externalIp": "A String", # The external IP to define in the NIC. |
| 846 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 847 | "network": "A String", # The network to connect the NIC to. |
| 848 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 849 | }, |
| 850 | ], |
| 851 | "networkTags": [ # A map of network tags to associate with the VM. |
| 852 | "A String", |
| 853 | ], |
| 854 | "project": "A String", # The GCP target project ID or project name. |
| 855 | "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. |
| 856 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 857 | "vmName": "A String", # The name of the VM to create. |
| 858 | "zone": "A String", # The zone in which to create the VM. |
| 859 | }, |
| 860 | "createTime": "A String", # Output only. The time the clone job was created (as an API call, not when it was actually created in the target). |
| 861 | "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 Clone Job's state. |
| 862 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 863 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 864 | { |
| 865 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 866 | }, |
| 867 | ], |
| 868 | "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. |
| 869 | }, |
| 870 | "name": "A String", # The name of the clone. |
| 871 | "state": "A String", # Output only. State of the clone job. |
| 872 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 873 | }, |
| 874 | ], |
| 875 | "recentCutoverJobs": [ # 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. |
| 876 | { # 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. |
| 877 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 878 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 879 | "A String", |
| 880 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 881 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 882 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 883 | "type": "A String", # The license type that was used in OS adaptation. |
| 884 | }, |
| 885 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 886 | "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). |
| 887 | "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. |
| 888 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 889 | { # 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 |
| 890 | "key": "A String", # The label key of Node resource to reference. |
| 891 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 892 | "values": [ # Corresponds to the label values of Node resource. |
| 893 | "A String", |
| 894 | ], |
| 895 | }, |
| 896 | ], |
| 897 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 898 | "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. |
| 899 | }, |
| 900 | "diskType": "A String", # The disk type to use in the VM. |
| 901 | "labels": { # A map of labels to associate with the VM. |
| 902 | "a_key": "A String", |
| 903 | }, |
| 904 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 905 | "machineType": "A String", # The machine type to create the VM with. |
| 906 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 907 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 908 | "a_key": "A String", |
| 909 | }, |
| 910 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 911 | { # NetworkInterface represents a NIC of a VM. |
| 912 | "externalIp": "A String", # The external IP to define in the NIC. |
| 913 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 914 | "network": "A String", # The network to connect the NIC to. |
| 915 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 916 | }, |
| 917 | ], |
| 918 | "networkTags": [ # A map of network tags to associate with the VM. |
| 919 | "A String", |
| 920 | ], |
| 921 | "project": "A String", # The GCP target project ID or project name. |
| 922 | "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. |
| 923 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 924 | "vmName": "A String", # The name of the VM to create. |
| 925 | "zone": "A String", # The zone in which to create the VM. |
| 926 | }, |
| 927 | "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). |
| 928 | "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. |
| 929 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 930 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 931 | { |
| 932 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 933 | }, |
| 934 | ], |
| 935 | "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. |
| 936 | }, |
| 937 | "name": "A String", # Output only. The name of the cutover job. |
| 938 | "progressPercent": 42, # Output only. The current progress in percentage of the cutover job. |
| 939 | "state": "A String", # Output only. State of the cutover job. |
| 940 | "stateMessage": "A String", # Output only. A message providing possible extra details about the current state. |
| 941 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 942 | }, |
| 943 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 944 | "sourceVmId": "A String", # The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. |
| 945 | "state": "A String", # Output only. State of the MigratingVm. |
| 946 | "stateTime": "A String", # Output only. The last time the migrating VM state was updated. |
| 947 | "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. |
| 948 | }, |
| 949 | ], |
| 950 | "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. |
| 951 | "unreachable": [ # Output only. Locations that could not be reached. |
| 952 | "A String", |
| 953 | ], |
| 954 | }</pre> |
| 955 | </div> |
| 956 | |
| 957 | <div class="method"> |
| 958 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 959 | <pre>Retrieves the next page of results. |
| 960 | |
| 961 | Args: |
| 962 | previous_request: The request for the previous page. (required) |
| 963 | previous_response: The response from the request for the previous page. (required) |
| 964 | |
| 965 | Returns: |
| 966 | A request object that you can call 'execute()' on to request the next |
| 967 | page. Returns None if there are no more items in the collection. |
| 968 | </pre> |
| 969 | </div> |
| 970 | |
| 971 | <div class="method"> |
| 972 | <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| 973 | <pre>Updates the parameters of a single MigratingVm. |
| 974 | |
| 975 | Args: |
| 976 | name: string, Output only. The identifier of the MigratingVm. (required) |
| 977 | body: object, The request body. |
| 978 | The object takes the form of: |
| 979 | |
| 980 | { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. |
| 981 | "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 982 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 983 | "A String", |
| 984 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 985 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. |
| 986 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 987 | "type": "A String", # The license type that was used in OS adaptation. |
| 988 | }, |
| 989 | "bootOption": "A String", # Output only. The VM Boot Option, as set in the source vm. |
| 990 | "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). |
| 991 | "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. |
| 992 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 993 | { # 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 |
| 994 | "key": "A String", # The label key of Node resource to reference. |
| 995 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 996 | "values": [ # Corresponds to the label values of Node resource. |
| 997 | "A String", |
| 998 | ], |
| 999 | }, |
| 1000 | ], |
| 1001 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 1002 | "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. |
| 1003 | }, |
| 1004 | "diskType": "A String", # The disk type to use in the VM. |
| 1005 | "labels": { # A map of labels to associate with the VM. |
| 1006 | "a_key": "A String", |
| 1007 | }, |
| 1008 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 1009 | "machineType": "A String", # The machine type to create the VM with. |
| 1010 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 1011 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 1012 | "a_key": "A String", |
| 1013 | }, |
| 1014 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 1015 | { # NetworkInterface represents a NIC of a VM. |
| 1016 | "externalIp": "A String", # The external IP to define in the NIC. |
| 1017 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 1018 | "network": "A String", # The network to connect the NIC to. |
| 1019 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 1020 | }, |
| 1021 | ], |
| 1022 | "networkTags": [ # A map of network tags to associate with the VM. |
| 1023 | "A String", |
| 1024 | ], |
| 1025 | "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. |
| 1026 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 1027 | "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. |
| 1028 | "vmName": "A String", # The name of the VM to create. |
| 1029 | "zone": "A String", # The zone in which to create the VM. |
| 1030 | }, |
| 1031 | "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). |
| 1032 | "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. |
| 1033 | "progressPercent": 42, # The current progress in percentage of this cycle. |
| 1034 | "startTime": "A String", # The time the replication cycle has started. |
| 1035 | }, |
| 1036 | "description": "A String", # The description attached to the migrating VM by the user. |
| 1037 | "displayName": "A String", # The display name attached to the MigratingVm by the user. |
| 1038 | "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 on the state of the Migrating VM in case of an error in replication. |
| 1039 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1040 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1041 | { |
| 1042 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1043 | }, |
| 1044 | ], |
| 1045 | "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. |
| 1046 | }, |
| 1047 | "group": "A String", # Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. |
| 1048 | "labels": { # The labels of the migrating VM. |
| 1049 | "a_key": "A String", |
| 1050 | }, |
| 1051 | "lastSync": { # ReplicationSync contain information about the last replica sync to the cloud. # Output only. The most updated snapshot created time in the source that finished replication. |
| 1052 | "lastSyncTime": "A String", # The most updated snapshot created time in the source that finished replication. |
| 1053 | }, |
| 1054 | "name": "A String", # Output only. The identifier of the MigratingVm. |
| 1055 | "policy": { # A policy for scheduling replications. # The replication schedule policy. |
| 1056 | "idleDuration": "A String", # The idle duration between replication stages. |
| 1057 | "skipOsAdaptation": True or False, # A flag to indicate whether to skip OS adaptation during the replication sync. OS adaptation is a process where the VM's operating system undergoes changes and adaptations to fully function on Compute Engine. |
| 1058 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1059 | "recentCloneJobs": [ # 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. |
| 1060 | { # 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. |
| 1061 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 1062 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 1063 | "A String", |
| 1064 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1065 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 1066 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 1067 | "type": "A String", # The license type that was used in OS adaptation. |
| 1068 | }, |
| 1069 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 1070 | "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). |
| 1071 | "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. |
| 1072 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 1073 | { # 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 |
| 1074 | "key": "A String", # The label key of Node resource to reference. |
| 1075 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 1076 | "values": [ # Corresponds to the label values of Node resource. |
| 1077 | "A String", |
| 1078 | ], |
| 1079 | }, |
| 1080 | ], |
| 1081 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 1082 | "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. |
| 1083 | }, |
| 1084 | "diskType": "A String", # The disk type to use in the VM. |
| 1085 | "labels": { # A map of labels to associate with the VM. |
| 1086 | "a_key": "A String", |
| 1087 | }, |
| 1088 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 1089 | "machineType": "A String", # The machine type to create the VM with. |
| 1090 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 1091 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 1092 | "a_key": "A String", |
| 1093 | }, |
| 1094 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 1095 | { # NetworkInterface represents a NIC of a VM. |
| 1096 | "externalIp": "A String", # The external IP to define in the NIC. |
| 1097 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 1098 | "network": "A String", # The network to connect the NIC to. |
| 1099 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 1100 | }, |
| 1101 | ], |
| 1102 | "networkTags": [ # A map of network tags to associate with the VM. |
| 1103 | "A String", |
| 1104 | ], |
| 1105 | "project": "A String", # The GCP target project ID or project name. |
| 1106 | "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. |
| 1107 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 1108 | "vmName": "A String", # The name of the VM to create. |
| 1109 | "zone": "A String", # The zone in which to create the VM. |
| 1110 | }, |
| 1111 | "createTime": "A String", # Output only. The time the clone job was created (as an API call, not when it was actually created in the target). |
| 1112 | "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 Clone Job's state. |
| 1113 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1114 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1115 | { |
| 1116 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1117 | }, |
| 1118 | ], |
| 1119 | "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. |
| 1120 | }, |
| 1121 | "name": "A String", # The name of the clone. |
| 1122 | "state": "A String", # Output only. State of the clone job. |
| 1123 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 1124 | }, |
| 1125 | ], |
| 1126 | "recentCutoverJobs": [ # 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. |
| 1127 | { # 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. |
| 1128 | "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. |
| yoshi-code-bot | 278a490 | 2021-12-14 03:32:50 -0800 | [diff] [blame] | 1129 | "additionalLicenses": [ # Additional licenses to assign to the VM. |
| 1130 | "A String", |
| 1131 | ], |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1132 | "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. |
| 1133 | "osLicense": "A String", # The OS license returned from the adaptation module's report. |
| 1134 | "type": "A String", # The license type that was used in OS adaptation. |
| 1135 | }, |
| 1136 | "bootOption": "A String", # The VM Boot Option, as set in the source vm. |
| 1137 | "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). |
| 1138 | "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. |
| 1139 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations for sole tenant nodes. |
| 1140 | { # 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 |
| 1141 | "key": "A String", # The label key of Node resource to reference. |
| 1142 | "operator": "A String", # The operator to use for the node resources specified in the `values` parameter. |
| 1143 | "values": [ # Corresponds to the label values of Node resource. |
| 1144 | "A String", |
| 1145 | ], |
| 1146 | }, |
| 1147 | ], |
| 1148 | "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. |
| 1149 | "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. |
| 1150 | }, |
| 1151 | "diskType": "A String", # The disk type to use in the VM. |
| 1152 | "labels": { # A map of labels to associate with the VM. |
| 1153 | "a_key": "A String", |
| 1154 | }, |
| 1155 | "licenseType": "A String", # The license type to use in OS adaptation. |
| 1156 | "machineType": "A String", # The machine type to create the VM with. |
| 1157 | "machineTypeSeries": "A String", # The machine type series to create the VM with. |
| 1158 | "metadata": { # The metadata key/value pairs to assign to the VM. |
| 1159 | "a_key": "A String", |
| 1160 | }, |
| 1161 | "networkInterfaces": [ # List of NICs connected to this VM. |
| 1162 | { # NetworkInterface represents a NIC of a VM. |
| 1163 | "externalIp": "A String", # The external IP to define in the NIC. |
| 1164 | "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. |
| 1165 | "network": "A String", # The network to connect the NIC to. |
| 1166 | "subnetwork": "A String", # The subnetwork to connect the NIC to. |
| 1167 | }, |
| 1168 | ], |
| 1169 | "networkTags": [ # A map of network tags to associate with the VM. |
| 1170 | "A String", |
| 1171 | ], |
| 1172 | "project": "A String", # The GCP target project ID or project name. |
| 1173 | "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. |
| 1174 | "serviceAccount": "A String", # The service account to associate the VM with. |
| 1175 | "vmName": "A String", # The name of the VM to create. |
| 1176 | "zone": "A String", # The zone in which to create the VM. |
| 1177 | }, |
| 1178 | "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). |
| 1179 | "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. |
| 1180 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1181 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1182 | { |
| 1183 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1184 | }, |
| 1185 | ], |
| 1186 | "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. |
| 1187 | }, |
| 1188 | "name": "A String", # Output only. The name of the cutover job. |
| 1189 | "progressPercent": 42, # Output only. The current progress in percentage of the cutover job. |
| 1190 | "state": "A String", # Output only. State of the cutover job. |
| 1191 | "stateMessage": "A String", # Output only. A message providing possible extra details about the current state. |
| 1192 | "stateTime": "A String", # Output only. The time the state was last updated. |
| 1193 | }, |
| 1194 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 1195 | "sourceVmId": "A String", # The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. |
| 1196 | "state": "A String", # Output only. State of the MigratingVm. |
| 1197 | "stateTime": "A String", # Output only. The last time the migrating VM state was updated. |
| 1198 | "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. |
| 1199 | } |
| 1200 | |
| 1201 | 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). |
| 1202 | updateMask: string, Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
| 1203 | x__xgafv: string, V1 error format. |
| 1204 | Allowed values |
| 1205 | 1 - v1 error format |
| 1206 | 2 - v2 error format |
| 1207 | |
| 1208 | Returns: |
| 1209 | An object of the form: |
| 1210 | |
| 1211 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1212 | "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. |
| 1213 | "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. |
| 1214 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1215 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1216 | { |
| 1217 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1218 | }, |
| 1219 | ], |
| 1220 | "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. |
| 1221 | }, |
| 1222 | "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. |
| 1223 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1224 | }, |
| 1225 | "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}`. |
| 1226 | "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`. |
| 1227 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1228 | }, |
| 1229 | }</pre> |
| 1230 | </div> |
| 1231 | |
| 1232 | <div class="method"> |
| 1233 | <code class="details" id="pauseMigration">pauseMigration(migratingVm, body=None, x__xgafv=None)</code> |
| 1234 | <pre>Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused. |
| 1235 | |
| 1236 | Args: |
| 1237 | migratingVm: string, Required. The name of the MigratingVm. (required) |
| 1238 | body: object, The request body. |
| 1239 | The object takes the form of: |
| 1240 | |
| 1241 | { # Request message for 'PauseMigration' request. |
| 1242 | } |
| 1243 | |
| 1244 | x__xgafv: string, V1 error format. |
| 1245 | Allowed values |
| 1246 | 1 - v1 error format |
| 1247 | 2 - v2 error format |
| 1248 | |
| 1249 | Returns: |
| 1250 | An object of the form: |
| 1251 | |
| 1252 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1253 | "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. |
| 1254 | "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. |
| 1255 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1256 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1257 | { |
| 1258 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1259 | }, |
| 1260 | ], |
| 1261 | "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. |
| 1262 | }, |
| 1263 | "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. |
| 1264 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1265 | }, |
| 1266 | "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}`. |
| 1267 | "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`. |
| 1268 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1269 | }, |
| 1270 | }</pre> |
| 1271 | </div> |
| 1272 | |
| 1273 | <div class="method"> |
| 1274 | <code class="details" id="resumeMigration">resumeMigration(migratingVm, body=None, x__xgafv=None)</code> |
| 1275 | <pre>Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots. |
| 1276 | |
| 1277 | Args: |
| 1278 | migratingVm: string, Required. The name of the MigratingVm. (required) |
| 1279 | body: object, The request body. |
| 1280 | The object takes the form of: |
| 1281 | |
| 1282 | { # Request message for 'ResumeMigration' request. |
| 1283 | } |
| 1284 | |
| 1285 | x__xgafv: string, V1 error format. |
| 1286 | Allowed values |
| 1287 | 1 - v1 error format |
| 1288 | 2 - v2 error format |
| 1289 | |
| 1290 | Returns: |
| 1291 | An object of the form: |
| 1292 | |
| 1293 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1294 | "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. |
| 1295 | "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. |
| 1296 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1297 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1298 | { |
| 1299 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1300 | }, |
| 1301 | ], |
| 1302 | "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. |
| 1303 | }, |
| 1304 | "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. |
| 1305 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1306 | }, |
| 1307 | "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}`. |
| 1308 | "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`. |
| 1309 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1310 | }, |
| 1311 | }</pre> |
| 1312 | </div> |
| 1313 | |
| 1314 | <div class="method"> |
| 1315 | <code class="details" id="startMigration">startMigration(migratingVm, body=None, x__xgafv=None)</code> |
| 1316 | <pre>Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy. |
| 1317 | |
| 1318 | Args: |
| 1319 | migratingVm: string, Required. The name of the MigratingVm. (required) |
| 1320 | body: object, The request body. |
| 1321 | The object takes the form of: |
| 1322 | |
| 1323 | { # Request message for 'StartMigrationRequest' request. |
| 1324 | } |
| 1325 | |
| 1326 | x__xgafv: string, V1 error format. |
| 1327 | Allowed values |
| 1328 | 1 - v1 error format |
| 1329 | 2 - v2 error format |
| 1330 | |
| 1331 | Returns: |
| 1332 | An object of the form: |
| 1333 | |
| 1334 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1335 | "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. |
| 1336 | "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. |
| 1337 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1338 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1339 | { |
| 1340 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1341 | }, |
| 1342 | ], |
| 1343 | "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. |
| 1344 | }, |
| 1345 | "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. |
| 1346 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1347 | }, |
| 1348 | "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}`. |
| 1349 | "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`. |
| 1350 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1351 | }, |
| 1352 | }</pre> |
| 1353 | </div> |
| 1354 | |
| 1355 | </body></html> |