Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class ReplicationCycle.
ReplicationCycle contains information about the current replication cycle status.
Generated from protobuf message google.cloud.vmmigration.v1.ReplicationCycle
Namespace
Google \ Cloud \ VMMigration \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The identifier of the ReplicationCycle. |
↳ cycle_number |
int
The cycle's ordinal number. |
↳ start_time |
Google\Protobuf\Timestamp
The time the replication cycle has started. |
↳ end_time |
Google\Protobuf\Timestamp
The time the replication cycle has ended. |
↳ total_pause_duration |
Google\Protobuf\Duration
The accumulated duration the replication cycle was paused. |
↳ progress_percent |
int
The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. |
↳ steps |
array<CycleStep>
The cycle's steps list representing its progress. |
↳ state |
int
State of the ReplicationCycle. |
↳ error |
Google\Rpc\Status
Provides details on the state of the cycle in case of an error. |
getName
The identifier of the ReplicationCycle.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The identifier of the ReplicationCycle.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCycleNumber
The cycle's ordinal number.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCycleNumber
The cycle's ordinal number.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
The time the replication cycle has started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
The time the replication cycle has started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
The time the replication cycle has ended.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
The time the replication cycle has ended.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTotalPauseDuration
The accumulated duration the replication cycle was paused.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasTotalPauseDuration
clearTotalPauseDuration
setTotalPauseDuration
The accumulated duration the replication cycle was paused.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProgressPercent
The current progress in percentage of this cycle.
Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
| Returns | |
|---|---|
| Type | Description |
int |
|
setProgressPercent
The current progress in percentage of this cycle.
Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSteps
The cycle's steps list representing its progress.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSteps
The cycle's steps list representing its progress.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CycleStep>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
State of the ReplicationCycle.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
State of the ReplicationCycle.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getError
Provides details on the state of the cycle in case of an error.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null |
|
hasError
clearError
setError
Provides details on the state of the cycle in case of an error.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this |
|