Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class RolloutControl.
RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it.
Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.RolloutControl
Namespace
Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ run_params |
RolloutControl\RunRolloutActionParams
Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed. |
↳ action |
int
Required. Action to be performed on the Rollout. The default behavior is to run the rollout until it naturally reaches a terminal state. |
getRunParams
Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.
| Returns | |
|---|---|
| Type | Description |
RolloutControl\RunRolloutActionParams|null |
|
hasRunParams
setRunParams
Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.
| Parameter | |
|---|---|
| Name | Description |
var |
RolloutControl\RunRolloutActionParams
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
Required. Action to be performed on the Rollout.
The default behavior is to run the rollout until it naturally reaches a terminal state.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type RolloutAction. |
setAction
Required. Action to be performed on the Rollout.
The default behavior is to run the rollout until it naturally reaches a terminal state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type RolloutAction. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActionParams
| Returns | |
|---|---|
| Type | Description |
string |
|