Reference documentation and code samples for the Google Cloud Deploy V1 Client class CanaryDeployment.
CanaryDeployment represents the canary deployment configuration
Generated from protobuf message google.cloud.deploy.v1.CanaryDeployment
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ percentages |
array
Required. The percentage based deployments that will occur as a part of a |
↳ verify |
bool
Whether to run verify tests after each percentage deployment. |
↳ predeploy |
Google\Cloud\Deploy\V1\Predeploy
Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase. |
↳ postdeploy |
Google\Cloud\Deploy\V1\Postdeploy
Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase. |
getPercentages
Required. The percentage based deployments that will occur as a part of a
Rollout. List is expected in ascending order and each integer n is
0 <= n < 100.
If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPercentages
Required. The percentage based deployments that will occur as a part of a
Rollout. List is expected in ascending order and each integer n is
0 <= n < 100.
If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerify
Whether to run verify tests after each percentage deployment.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVerify
Whether to run verify tests after each percentage deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPredeploy
Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Predeploy|null |
|
hasPredeploy
clearPredeploy
setPredeploy
Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\Predeploy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostdeploy
Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Postdeploy|null |
|
hasPostdeploy
clearPostdeploy
setPostdeploy
Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\Postdeploy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|