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 \ CustomCanaryDeploymentMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ phase_id |
string
Required. The ID to assign to the |
↳ 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 |
↳ verify |
bool
Whether to run verify tests after the deployment. |
↳ predeploy |
Google\Cloud\Deploy\V1\Predeploy
Optional. Configuration for the predeploy job of this 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 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProfiles
Skaffold profiles to use when rendering the manifest for this phase.
These are in addition to the profiles list specified in the
DeliveryPipeline stage.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerify
Whether to run verify tests after the deployment.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVerify
Whether to run verify tests after the deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPredeploy
Optional. Configuration for the predeploy job of this 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 this 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 this 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 this 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 |
|