Reference documentation and code samples for the Google Cloud Deploy V1 Client class PhaseConfig.
PhaseConfig represents the configuration for a phase in the custom
canary deployment.
Generated from protobuf message google.cloud.deploy.v1.CustomCanaryDeployment.PhaseConfig
Namespace
Google \ Cloud \ Deploy \ V1 \ CustomCanaryDeployment
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ phase_id
string
Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
↳ percentage
int
Required. Percentage deployment for the phase.
↳ profiles
array
Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.
Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
getPhaseId
Required. The ID to assign to the Rollout phase.
This value must consist of lower-case letters, numbers, and hyphens,
start with a letter and end with a letter or a number, and have a max
length of 63 characters. In other words, it must match the following
regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
Returns
Type
Description
string
setPhaseId
Required. The ID to assign to the Rollout phase.
This value must consist of lower-case letters, numbers, and hyphens,
start with a letter and end with a letter or a number, and have a max
length of 63 characters. In other words, it must match the following
regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPercentage
Required. Percentage deployment for the phase.
Returns
Type
Description
int
setPercentage
Required. Percentage deployment for the phase.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getProfiles
Skaffold profiles to use when rendering the manifest for this phase.
These are in addition to the profiles list specified in the
DeliveryPipeline stage.
[[["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 PhaseConfig (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.CustomCanaryDeployment.PhaseConfig)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.CustomCanaryDeployment.PhaseConfig) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class PhaseConfig.\n\nPhaseConfig represents the configuration for a phase in the custom\ncanary deployment.\n\nGenerated from protobuf message `google.cloud.deploy.v1.CustomCanaryDeployment.PhaseConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1 \\\\ CustomCanaryDeployment\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPhaseId\n\nRequired. The ID to assign to the `Rollout` phase.\n\nThis value must consist of lower-case letters, numbers, and hyphens,\nstart with a letter and end with a letter or a number, and have a max\nlength of 63 characters. In other words, it must match the following\nregex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.\n\n### setPhaseId\n\nRequired. The ID to assign to the `Rollout` phase.\n\nThis value must consist of lower-case letters, numbers, and hyphens,\nstart with a letter and end with a letter or a number, and have a max\nlength of 63 characters. In other words, it must match the following\nregex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.\n\n### getPercentage\n\nRequired. Percentage deployment for the phase.\n\n### setPercentage\n\nRequired. Percentage deployment for the phase.\n\n### getProfiles\n\nSkaffold profiles to use when rendering the manifest for this phase.\n\nThese are in addition to the profiles list specified in the\n`DeliveryPipeline` stage.\n\n### setProfiles\n\nSkaffold profiles to use when rendering the manifest for this phase.\n\nThese are in addition to the profiles list specified in the\n`DeliveryPipeline` stage.\n\n### getVerify\n\nWhether to run verify tests after the deployment.\n\n### setVerify\n\nWhether to run verify tests after the deployment.\n\n### getPredeploy\n\nOptional. Configuration for the predeploy job of this phase. If this is\nnot 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 this phase. If this is\nnot configured, there will be no predeploy job for this phase.\n\n### getPostdeploy\n\nOptional. Configuration for the postdeploy job of this phase. If this is\nnot 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 this phase. If this is\nnot configured, there will be no postdeploy job for this phase."]]
