# REST Resource: projects.locations.sources.migratingVms.cutoverJobs

- [Resource: CutoverJob](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob)
  - [JSON representation](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.SCHEMA_REPRESENTATION)
  - [State](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.State)
  - [CutoverStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.CutoverStep)
    - [JSON representation](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.CutoverStep.SCHEMA_REPRESENTATION)
  - [ShuttingDownSourceVMStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.ShuttingDownSourceVMStep)
- [Methods](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#METHODS_SUMMARY)

## Resource: CutoverJob

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.

| JSON representation |
|---|
| ``` { "createTime": string, "endTime": string, "name": string, "state": enum (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.State`), "stateTime": string, "progressPercent": integer, "error": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/Status`) }, "stateMessage": string, "steps": [ { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.CutoverStep`) } ], // Union field `target_vm_details` can be only one of the following: "computeEngineTargetDetails": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/ComputeEngineTargetDetails`) }, "computeEngineDisksTargetDetails": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/ComputeEngineDisksTargetDetails`) } // End of list of possible types for union field `target_vm_details`. } ``` |

| Fields ||
|---|---|
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `endTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time the cutover job had finished. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `name` | `string` Output only. The name of the cutover job. |
| `state` | ``enum (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.State`)`` Output only. State of the cutover job. |
| `stateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time the state was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `progressPercent` | `integer` Output only. The current progress in percentage of the cutover job. |
| `error` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/Status`)`` Output only. Provides details for the errors that led to the Cutover Job's state. |
| `stateMessage` | `string` Output only. A message providing possible extra details about the current state. |
| `steps[]` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.CutoverStep`)`` Output only. The cutover steps list representing its progress. |
| Union field `target_vm_details`. Details of the VM to create as the target of this cutover job. `target_vm_details` can be only one of the following: ||
| `computeEngineTargetDetails` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/ComputeEngineTargetDetails`)`` Output only. Details of the target VM in Compute Engine. |
| `computeEngineDisksTargetDetails` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/ComputeEngineDisksTargetDetails`)`` Output only. Details of the target Persistent Disks in Compute Engine. |

### State

Possible states of the cutover job.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unknown. This is used for API compatibility only and is not used by the system. |
| `PENDING` | The cutover job has not yet started. |
| `FAILED` | The cutover job finished with errors. |
| `SUCCEEDED` | The cutover job finished successfully. |
| `CANCELLED` | The cutover job was cancelled. |
| `CANCELLING` | The cutover job is being cancelled. |
| `ACTIVE` | The cutover job is active and running. |
| `ADAPTING_OS` | OS adaptation is running as part of the cutover job to generate license. |

### CutoverStep

CutoverStep holds information about the cutover step progress.

| JSON representation |
|---|
| ``` { "startTime": string, "endTime": string, // Union field `step` can be only one of the following: "previousReplicationCycle": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle`) }, "shuttingDownSourceVm": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.ShuttingDownSourceVMStep`) }, "finalSync": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle`) }, "preparingVmDisks": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/PreparingVMDisksStep`) }, "instantiatingMigratedVm": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/InstantiatingMigratedVMStep`) } // End of list of possible types for union field `step`. } ``` |

| Fields ||
|---|---|
| `startTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The time the step has started. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `endTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The time the step has ended. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| Union field `step`. `step` can be only one of the following: ||
| `previousReplicationCycle` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle`)`` A replication cycle prior cutover step. |
| `shuttingDownSourceVm` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs#CutoverJob.ShuttingDownSourceVMStep`)`` Shutting down VM step. |
| `finalSync` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle`)`` Final sync step. |
| `preparingVmDisks` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/PreparingVMDisksStep`)`` Preparing VM disks step. |
| `instantiatingMigratedVm` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/InstantiatingMigratedVMStep`)`` Instantiating migrated VM step. |

### ShuttingDownSourceVMStep

This type has no fields.
ShuttingDownSourceVMStep contains specific step details.

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs/cancel` | Initiates the cancellation of a running cutover job. |
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs/create` | Initiates a Cutover of a specific migrating VM. |
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs/get` | Gets details of a single CutoverJob. |
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1/projects.locations.sources.migratingVms.cutoverJobs/list` | Lists the CutoverJobs of a migrating VM. |