Google Cloud Deploy V1 Client - Class CanaryDeployment (0.16.0)

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

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

Returns
TypeDescription
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.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getVerify

Whether to run verify tests after each percentage deployment.

Returns
TypeDescription
bool

setVerify

Whether to run verify tests after each percentage deployment.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Deploy\V1\Predeploy
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Deploy\V1\Postdeploy
Returns
TypeDescription
$this