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 \ V1
Methods
__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 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.
↳ verify
bool
Whether to run verify tests after each percentage deployment.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class CanaryDeployment (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.CanaryDeployment)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.CanaryDeployment)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.CanaryDeployment)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.CanaryDeployment)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.CanaryDeployment)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.CanaryDeployment)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.CanaryDeployment)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.CanaryDeployment)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.CanaryDeployment)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.CanaryDeployment)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.CanaryDeployment)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.CanaryDeployment)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.CanaryDeployment)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.CanaryDeployment)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.CanaryDeployment)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.CanaryDeployment)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.CanaryDeployment)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.CanaryDeployment)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.CanaryDeployment)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.CanaryDeployment)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.CanaryDeployment)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.CanaryDeployment)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.CanaryDeployment)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.CanaryDeployment) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class CanaryDeployment.\n\nCanaryDeployment represents the canary deployment configuration\n\nGenerated from protobuf message `google.cloud.deploy.v1.CanaryDeployment`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPercentages\n\nRequired. The percentage based deployments that will occur as a part of a\n`Rollout`. List is expected in ascending order and each integer n is\n0 \\\u003c= n \\\u003c 100.\n\nIf the GatewayServiceMesh is configured for Kubernetes, then the range for\nn is 0 \\\u003c= n \\\u003c= 100.\n\n### setPercentages\n\nRequired. The percentage based deployments that will occur as a part of a\n`Rollout`. List is expected in ascending order and each integer n is\n0 \\\u003c= n \\\u003c 100.\n\nIf the GatewayServiceMesh is configured for Kubernetes, then the range for\nn is 0 \\\u003c= n \\\u003c= 100.\n\n### getVerify\n\nWhether to run verify tests after each percentage deployment.\n\n### setVerify\n\nWhether to run verify tests after each percentage deployment.\n\n### getPredeploy\n\nOptional. Configuration for the predeploy job of the first phase. If this\nis not configured, there will be no predeploy job for this phase.\n\n### hasPredeploy\n\n### clearPredeploy\n\n### setPredeploy\n\nOptional. Configuration for the predeploy job of the first phase. If this\nis not configured, there will be no predeploy job for this phase.\n\n### getPostdeploy\n\nOptional. Configuration for the postdeploy job of the last phase. If this\nis not configured, there will be no postdeploy job for this phase.\n\n### hasPostdeploy\n\n### clearPostdeploy\n\n### setPostdeploy\n\nOptional. Configuration for the postdeploy job of the last phase. If this\nis not configured, there will be no postdeploy job for this phase."]]
