Google Cloud Deploy V1 Client - Class PromoteReleaseRule (0.14.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class PromoteReleaseRule.

PromoteRelease rule will automatically promote a release from the current target to a specified target.

Generated from protobuf message google.cloud.deploy.v1.PromoteReleaseRule

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ id`	`string` Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z][a-z0-9\-]{0,62}`.
`↳ wait`	`Google\Protobuf\Duration` Optional. How long the release need to be paused until being promoted to the next target.
`↳ destination_target_id`	`string` Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence.
`↳ condition`	`Google\Cloud\Deploy\V1\AutomationRuleCondition` Output only. Information around the state of the Automation rule.
`↳ destination_phase`	`string` Optional. The starting phase of the rollout created by this operation. Default to the first phase.

getId

Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z][a-z0-9\-]{0,62}.

Returns
Type	Description
`string`

setId

Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z][a-z0-9\-]{0,62}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getWait

Optional. How long the release need to be paused until being promoted to the next target.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasWait

clearWait

setWait

Optional. How long the release need to be paused until being promoted to the next target.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getDestinationTargetId

Optional. The ID of the stage in the pipeline to which this Release is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following:

The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline.
"@next", the next target in the promotion sequence.

Returns
Type	Description
`string`

setDestinationTargetId

The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline.
"@next", the next target in the promotion sequence.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCondition

Output only. Information around the state of the Automation rule.

Returns
Type	Description
`Google\Cloud\Deploy\V1\AutomationRuleCondition\|null`

hasCondition

clearCondition

setCondition

Output only. Information around the state of the Automation rule.

Parameter
Name	Description
`var`	`Google\Cloud\Deploy\V1\AutomationRuleCondition`

Returns
Type	Description
`$this`

getDestinationPhase

Optional. The starting phase of the rollout created by this operation.

Default to the first phase.

Returns
Type	Description
`string`

setDestinationPhase

Optional. The starting phase of the rollout created by this operation.

Default to the first phase.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`