Google Cloud Vm Migration V1 Client - Class MigratingVm (0.6.5)

Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class MigratingVm.

MigratingVm describes the VM that will be migrated from a Source environment and its replication state.

Generated from protobuf message google.cloud.vmmigration.v1.MigratingVm

Namespace

Google \ Cloud \ VMMigration \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ compute_engine_target_defaults
Google\Cloud\VMMigration\V1\ComputeEngineTargetDefaults

Details of the target VM in Compute Engine.

↳ aws_source_vm_details
Google\Cloud\VMMigration\V1\AwsSourceVmDetails

Output only. Details of the VM from an AWS source.

↳ name
string

Output only. The identifier of the MigratingVm.

↳ source_vm_id
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-

↳ display_name
string

The display name attached to the MigratingVm by the user.

↳ description
string

The description attached to the migrating VM by the user.

↳ policy
Google\Cloud\VMMigration\V1\SchedulePolicy

The replication schedule policy.

↳ create_time
Google\Protobuf\Timestamp

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

↳ update_time
Google\Protobuf\Timestamp

Output only. The last time the migrating VM resource was updated.

↳ last_sync
Google\Cloud\VMMigration\V1\ReplicationSync

Output only. The most updated snapshot created time in the source that finished replication.

↳ state
int

Output only. State of the MigratingVm.

↳ state_time
Google\Protobuf\Timestamp

Output only. The last time the migrating VM state was updated.

↳ current_sync_info
Google\Cloud\VMMigration\V1\ReplicationCycle

Output only. The percentage progress of the current running replication cycle.

↳ group
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.

↳ labels
array| Google\Protobuf\Internal\MapField

The labels of the migrating VM.

↳ recent_clone_jobs
array< Google\Cloud\VMMigration\V1\CloneJob >

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.

↳ error
Google\Rpc\Status

Output only. Provides details on the state of the Migrating VM in case of an error in replication.

↳ recent_cutover_jobs
array< Google\Cloud\VMMigration\V1\CutoverJob >

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.

getComputeEngineTargetDefaults

Details of the target VM in Compute Engine.

hasComputeEngineTargetDefaults

setComputeEngineTargetDefaults

Details of the target VM in Compute Engine.

Returns
Type
Description
$this

getAwsSourceVmDetails

Output only. Details of the VM from an AWS source.

Returns
Type
Description

hasAwsSourceVmDetails

setAwsSourceVmDetails

Output only. Details of the VM from an AWS source.

Parameter
Name
Description
Returns
Type
Description
$this

getName

Output only. The identifier of the MigratingVm.

Returns
Type
Description
string

setName

Output only. The identifier of the MigratingVm.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSourceVmId

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-

Returns
Type
Description
string

setSourceVmId

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-

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

The display name attached to the MigratingVm by the user.

Returns
Type
Description
string

setDisplayName

The display name attached to the MigratingVm by the user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

The description attached to the migrating VM by the user.

Returns
Type
Description
string

setDescription

The description attached to the migrating VM by the user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPolicy

The replication schedule policy.

Returns
Type
Description

hasPolicy

clearPolicy

setPolicy

The replication schedule policy.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

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

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The last time the migrating VM resource was updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last time the migrating VM resource was updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLastSync

Output only. The most updated snapshot created time in the source that finished replication.

Returns
Type
Description

hasLastSync

clearLastSync

setLastSync

Output only. The most updated snapshot created time in the source that finished replication.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. State of the MigratingVm.

Returns
Type
Description
int

setState

Output only. State of the MigratingVm.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getStateTime

Output only. The last time the migrating VM state was updated.

Returns
Type
Description

hasStateTime

clearStateTime

setStateTime

Output only. The last time the migrating VM state was updated.

Parameter
Name
Description
Returns
Type
Description
$this

getCurrentSyncInfo

Output only. The percentage progress of the current running replication cycle.

Returns
Type
Description

hasCurrentSyncInfo

clearCurrentSyncInfo

setCurrentSyncInfo

Output only. The percentage progress of the current running replication cycle.

Parameter
Name
Description
Returns
Type
Description
$this

getGroup

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.

Returns
Type
Description
string

setGroup

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLabels

The labels of the migrating VM.

Returns
Type
Description

setLabels

The labels of the migrating VM.

Parameter
Name
Description
Returns
Type
Description
$this

getRecentCloneJobs

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.

Returns
Type
Description

setRecentCloneJobs

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.

Parameter
Name
Description
Returns
Type
Description
$this

getError

Output only. Provides details on the state of the Migrating VM in case of an error in replication.

Returns
Type
Description

hasError

clearError

setError

Output only. Provides details on the state of the Migrating VM in case of an error in replication.

Parameter
Name
Description
Returns
Type
Description
$this

getRecentCutoverJobs

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.

Returns
Type
Description

setRecentCutoverJobs

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.

Parameter
Name
Description
Returns
Type
Description
$this

getTargetVmDefaults

Returns
Type
Description
string

getSourceVmDetails

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: