Reference documentation and code samples for the Google Cloud Deploy V1 Client class RollbackAttempt.
RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.
Generated from protobuf message google.cloud.deploy.v1.RollbackAttempt
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ destination_phase |
string
Output only. The phase to which the rollout will be rolled back to. |
↳ rollout_id |
string
Output only. ID of the rollback |
↳ state |
int
Output only. Valid state of this rollback action. |
↳ state_desc |
string
Output only. Description of the state of the Rollback. |
↳ disable_rollback_if_rollout_pending |
bool
Output only. If active rollout exists on the target, abort this rollback. |
getDestinationPhase
Output only. The phase to which the rollout will be rolled back to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDestinationPhase
Output only. The phase to which the rollout will be rolled back to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutId
Output only. ID of the rollback Rollout to create.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRolloutId
Output only. ID of the rollback Rollout to create.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Valid state of this rollback action.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. Valid state of this rollback action.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateDesc
Output only. Description of the state of the Rollback.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStateDesc
Output only. Description of the state of the Rollback.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableRollbackIfRolloutPending
Output only. If active rollout exists on the target, abort this rollback.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableRollbackIfRolloutPending
Output only. If active rollout exists on the target, abort this rollback.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|