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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

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

Returns
TypeDescription
Google\Cloud\VMMigration\V1\ComputeEngineTargetDefaults|null

hasComputeEngineTargetDefaults

setComputeEngineTargetDefaults

Details of the target VM in Compute Engine.

Parameter
NameDescription
var Google\Cloud\VMMigration\V1\ComputeEngineTargetDefaults
Returns
TypeDescription
$this

getName

Output only. The identifier of the MigratingVm.

Returns
TypeDescription
string

setName

Output only. The identifier of the MigratingVm.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The display name attached to the MigratingVm by the user.

Returns
TypeDescription
string

setDisplayName

The display name attached to the MigratingVm by the user.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

The description attached to the migrating VM by the user.

Returns
TypeDescription
string

setDescription

The description attached to the migrating VM by the user.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPolicy

The replication schedule policy.

Returns
TypeDescription
Google\Cloud\VMMigration\V1\SchedulePolicy|null

hasPolicy

clearPolicy

setPolicy

The replication schedule policy.

Parameter
NameDescription
var Google\Cloud\VMMigration\V1\SchedulePolicy
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Timestamp|null

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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLastSync

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

Returns
TypeDescription
Google\Cloud\VMMigration\V1\ReplicationSync|null

hasLastSync

clearLastSync

setLastSync

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

Parameter
NameDescription
var Google\Cloud\VMMigration\V1\ReplicationSync
Returns
TypeDescription
$this

getState

Output only. State of the MigratingVm.

Returns
TypeDescription
int

setState

Output only. State of the MigratingVm.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStateTime

clearStateTime

setStateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCurrentSyncInfo

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

Returns
TypeDescription
Google\Cloud\VMMigration\V1\ReplicationCycle|null

hasCurrentSyncInfo

clearCurrentSyncInfo

setCurrentSyncInfo

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

Parameter
NameDescription
var Google\Cloud\VMMigration\V1\ReplicationCycle
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getLabels

The labels of the migrating VM.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

The labels of the migrating VM.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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
NameDescription
var array<Google\Cloud\VMMigration\V1\CloneJob>
Returns
TypeDescription
$this

getError

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

Returns
TypeDescription
Google\Rpc\Status|null

hasError

clearError

setError

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

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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
NameDescription
var array<Google\Cloud\VMMigration\V1\CutoverJob>
Returns
TypeDescription
$this

getTargetVmDefaults

Returns
TypeDescription
string