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

- [Resource: ReplicationCycle](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle)
  - [JSON representation](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.SCHEMA_REPRESENTATION)
  - [CycleStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.CycleStep)
    - [JSON representation](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.CycleStep.SCHEMA_REPRESENTATION)
  - [InitializingReplicationStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.InitializingReplicationStep)
  - [ReplicatingStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.ReplicatingStep)
    - [JSON representation](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.ReplicatingStep.SCHEMA_REPRESENTATION)
  - [PostProcessingStep](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.PostProcessingStep)
  - [State](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.State)
- [Methods](https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#METHODS_SUMMARY)

## Resource: ReplicationCycle

ReplicationCycle contains information about the current replication cycle status.

| JSON representation |
|---|
| ``` { "name": string, "cycleNumber": integer, "startTime": string, "endTime": string, "totalPauseDuration": string, "progress": integer, "progressPercent": integer, "steps": [ { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.CycleStep`) } ], "state": enum (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.State`), "error": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/Status`) }, "warnings": [ { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/MigrationWarning`) } ] } ``` |

| Fields ||
|---|---|
| `name` | `string` The identifier of the ReplicationCycle. |
| `cycleNumber` | `integer` The cycle's ordinal number. |
| `startTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` The time the replication cycle 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 replication cycle 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"`. |
| `totalPauseDuration` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` The accumulated duration the replication cycle was paused. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |
| `progress (deprecated)` | `integer` > [!WARNING] > This item is deprecated! The current progress in percentage of this cycle. |
| `progressPercent (deprecated)` | `integer` > [!WARNING] > This item is deprecated! The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. |
| `steps[]` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.CycleStep`)`` The cycle's steps list representing its progress. |
| `state` | ``enum (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.State`)`` State of the ReplicationCycle. |
| `error` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/Status`)`` Output only. Provides details on the state of the cycle in case of an error. |
| `warnings[]` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/MigrationWarning`)`` Output only. Warnings that occurred during the cycle. |

### CycleStep

CycleStep holds information about a step progress.

| JSON representation |
|---|
| ``` { "startTime": string, "endTime": string, // Union field `step` can be only one of the following: "initializingReplication": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.InitializingReplicationStep`) }, "replicating": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.ReplicatingStep`) }, "postProcessing": { object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.PostProcessingStep`) } // 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 cycle 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 cycle 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: ||
| `initializingReplication` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.InitializingReplicationStep`)`` Initializing replication step. |
| `replicating` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.ReplicatingStep`)`` Replicating step. |
| `postProcessing` | ``object (`https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles#ReplicationCycle.PostProcessingStep`)`` Post processing step. |

### InitializingReplicationStep

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

### ReplicatingStep

ReplicatingStep contains specific step details.

| JSON representation |
|---|
| ``` { "totalBytes": string, "replicatedBytes": string, "lastTwoMinutesAverageBytesPerSecond": string, "lastThirtyMinutesAverageBytesPerSecond": string } ``` |

| Fields ||
|---|---|
| `totalBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Total bytes to be handled in the step. |
| `replicatedBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Replicated bytes in the step. |
| `lastTwoMinutesAverageBytesPerSecond` | `string (https://developers.google.com/discovery/v1/type-format format)` The source disks replication rate for the last 2 minutes in bytes per second. |
| `lastThirtyMinutesAverageBytesPerSecond` | `string (https://developers.google.com/discovery/v1/type-format format)` The source disks replication rate for the last 30 minutes in bytes per second. |

### PostProcessingStep

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

### State

Possible states of a replication cycle.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unknown. This is used for API compatibility only and is not used by the system. |
| `RUNNING` | The replication cycle is running. |
| `PAUSED` | The replication cycle is paused. |
| `FAILED` | The replication cycle finished with errors. |
| `SUCCEEDED` | The replication cycle finished successfully. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles/get` | Gets details of a single ReplicationCycle. |
| ### `https://docs.cloud.google.com/migrate/virtual-machines/docs/5.0/reference/rest/v1alpha1/projects.locations.sources.migratingVms.replicationCycles/list` | Lists ReplicationCycles in a given MigratingVM. |