Google Cloud Deploy V1 Client - Class TimedPromoteReleaseRule (1.5.0)

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

The TimedPromoteReleaseRule will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.

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

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,61}[a-z0-9])?.
↳ 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 * * "@next", the next target in the promotion sequence
↳ schedule string

Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
↳ time_zone string

Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).
↳ condition AutomationRuleCondition

Output only. Information around the state of the Automation rule.
↳ destination_phase string

Optional. The starting phase of the rollout created by this rule. 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,61}[a-z0-9])?.

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,61}[a-z0-9])?.

Parameter
Name Description
var string
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
  • "@next", the next target in the promotion sequence
Returns
Type Description
string

setDestinationTargetId

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
  • "@next", the next target in the promotion sequence
Parameter
Name Description
var string
Returns
Type Description
$this

getSchedule

Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.

Returns
Type Description
string

setSchedule

Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeZone

Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).

Returns
Type Description
string

setTimeZone

Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).

Parameter
Name Description
var string
Returns
Type Description
$this

getCondition

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

Returns
Type Description
AutomationRuleCondition|null

hasCondition

clearCondition

setCondition

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

Parameter
Name Description
var AutomationRuleCondition
Returns
Type Description
$this

getDestinationPhase

Optional. The starting phase of the rollout created by this rule. Default to the first phase.

Returns
Type Description
string

setDestinationPhase

Optional. The starting phase of the rollout created by this rule. Default to the first phase.

Parameter
Name Description
var string
Returns
Type Description
$this