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

Resource: ReplicationCycle

ReplicationCycle contains information about the current replication cycle status.

JSON representation
{
  "name": string,
  "cycleNumber": integer,
  "startTime": string,
  "endTime": string,
  "totalPauseDuration": string,
  "progressPercent": integer,
  "steps": [
    {
      object (CycleStep)
    }
  ],
  "state": enum (State),
  "error": {
    object (Status)
  },
  "warnings": [
    {
      object (MigrationWarning)
    }
  ]
}
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".

progressPercent
(deprecated)

integer

The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.

steps[]

object (CycleStep)

The cycle's steps list representing its progress.

state

enum (State)

State of the ReplicationCycle.

error

object (Status)

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

warnings[]

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

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

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.

MigrationWarning

Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.

JSON representation
{
  "code": enum (WarningCode),
  "warningMessage": {
    object (LocalizedMessage)
  },
  "actionItem": {
    object (LocalizedMessage)
  },
  "helpLinks": [
    {
      object (Link)
    }
  ],
  "warningTime": string
}
Fields
code

enum (WarningCode)

The warning code.

warningMessage

object (LocalizedMessage)

The localized warning message.

actionItem

object (LocalizedMessage)

Suggested action for solving the warning.

warningTime

string (Timestamp format)

The time the warning occurred.

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".

WarningCode

Represents possible warning codes.

Enums
WARNING_CODE_UNSPECIFIED Default value. This value is not used.
ADAPTATION_WARNING A warning originated from OS Adaptation.

LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

JSON representation
{
  "locale": string,
  "message": string
}
Fields
locale

string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

message

string

The localized error message in the above locale.

Methods

get

Gets details of a single ReplicationCycle.

list

Lists ReplicationCycles in a given MigratingVM.