You are now viewing Migrate to Virtual Machines (formerly Migrate for Compute Engine). For Migrate for Compute Engine versions 4.x, see the 4.x documentation.

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

Stay organized with collections Save and categorize content based on your preferences.

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 (CycleStep)
    }
  ],
  "state": enum (State),
  "error": {
    object (Status)
  }
}
Fields
name

string

The identifier of the ReplicationCycle.

cycleNumber

integer

The cycle's ordinal number.

startTime

string (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 (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 (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

The current progress in percentage of this cycle.

progressPercent

integer

The current progress in percentage of this cycle.

steps[]

object (CycleStep)

The cycle's steps list representing its progress.

state

enum (State)

State of the MigratingVm.

error

object (Status)

Provides details on the state of the cycle in case of an error.

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 (InitializingReplicationStep)
  },
  "replicating": {
    object (ReplicatingStep)
  },
  "postProcessing": {
    object (PostProcessingStep)
  }
  // End of list of possible types for union field step.
}
Fields
startTime

string (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 (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 (InitializingReplicationStep)

Initializing replication step.

replicating

object (ReplicatingStep)

Replicating step.

postProcessing

object (PostProcessingStep)

Post processing step.

InitializingReplicationStep

InitializingReplicationStep contains specific step details.

ReplicatingStep

ReplicatingStep contains specific step details.

JSON representation
{
  "totalBytes": string,
  "replicatedBytes": string,
  "lastTwoMinutesAverageBytesPerSecond": string,
  "lastThirtyMinutesAverageBytesPerSecond": string
}
Fields
totalBytes

string (int64 format)

Total bytes to be handled in the step.

replicatedBytes

string (int64 format)

Replicated bytes in the step.

lastTwoMinutesAverageBytesPerSecond

string (int64 format)

The source disks replication rate for the last 2 minutes in bytes per second.

lastThirtyMinutesAverageBytesPerSecond

string (int64 format)

The source disks replication rate for the last 30 minutes in bytes per second.

PostProcessingStep

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

get

Gets details of a single ReplicationCycle.

list

Lists ReplicationCycles in a given MigratingVM.