Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class CutoverJob.
CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.
Generated from protobuf message google.cloud.vmmigration.v1.CutoverJob
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ compute_engine_target_details |
Google\Cloud\VMMigration\V1\ComputeEngineTargetDetails
Output only. Details of the target VM in Compute Engine. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time the cutover job had finished. |
↳ name |
string
Output only. The name of the cutover job. |
↳ state |
int
Output only. State of the cutover job. |
↳ state_time |
Google\Protobuf\Timestamp
Output only. The time the state was last updated. |
↳ progress_percent |
int
Output only. The current progress in percentage of the cutover job. |
↳ error |
Google\Rpc\Status
Output only. Provides details for the errors that led to the Cutover Job's state. |
↳ state_message |
string
Output only. A message providing possible extra details about the current state. |
↳ steps |
array<Google\Cloud\VMMigration\V1\CutoverStep>
Output only. The cutover steps list representing its progress. |
getComputeEngineTargetDetails
Output only. Details of the target VM in Compute Engine.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VMMigration\V1\ComputeEngineTargetDetails|null | |
hasComputeEngineTargetDetails
setComputeEngineTargetDetails
Output only. Details of the target VM in Compute Engine.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VMMigration\V1\ComputeEngineTargetDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the cutover job was created (as an API call, not when it was actually created in the target).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. The time the cutover job had finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. The time the cutover job had finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Output only. The name of the cutover job.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The name of the cutover job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of the cutover job.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of the cutover job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateTime
Output only. The time the state was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStateTime
clearStateTime
setStateTime
Output only. The time the state was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgressPercent
Output only. The current progress in percentage of the cutover job.
| Returns | |
|---|---|
| Type | Description |
int | |
setProgressPercent
Output only. The current progress in percentage of the cutover job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. Provides details for the errors that led to the Cutover Job's state.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. Provides details for the errors that led to the Cutover Job's state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateMessage
Output only. A message providing possible extra details about the current state.
| Returns | |
|---|---|
| Type | Description |
string | |
setStateMessage
Output only. A message providing possible extra details about the current state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSteps
Output only. The cutover steps list representing its progress.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSteps
Output only. The cutover steps list representing its progress.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\VMMigration\V1\CutoverStep>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetVmDetails
| Returns | |
|---|---|
| Type | Description |
string | |