Google Cloud Deploy V1 Client - Class PhaseConfig (0.13.1)

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
NameDescription
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.

↳ 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, predeploy job will not be present for this phase.

↳ postdeploy Google\Cloud\Deploy\V1\Postdeploy

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPercentage

Required. Percentage deployment for the phase.

Returns
TypeDescription
int

setPercentage

Required. Percentage deployment for the phase.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this

getVerify

Whether to run verify tests after the deployment.

Returns
TypeDescription
bool

setVerify

Whether to run verify tests after the deployment.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPredeploy

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

Returns
TypeDescription
Google\Cloud\Deploy\V1\Predeploy|null

hasPredeploy

clearPredeploy

setPredeploy

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\Predeploy
Returns
TypeDescription
$this

getPostdeploy

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

Returns
TypeDescription
Google\Cloud\Deploy\V1\Postdeploy|null

hasPostdeploy

clearPostdeploy

setPostdeploy

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\Postdeploy
Returns
TypeDescription
$this