Google Cloud Deploy V1 Client - Class RepairRolloutRule (1.5.0)

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

The RepairRolloutRule automation rule will automatically repair a failed Rollout.

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

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])?.

↳ phases array

Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. 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])?$.

↳ jobs array

Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in source_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])?$.

↳ condition AutomationRuleCondition

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

↳ repair_phases array<RepairPhaseConfig>

Required. Defines the types of automatic repair phases for failed jobs.

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

getPhases

Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. 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
Google\Protobuf\Internal\RepeatedField

setPhases

Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. 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

getJobs

Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in source_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
Google\Protobuf\Internal\RepeatedField

setJobs

Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in source_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

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

getRepairPhases

Required. Defines the types of automatic repair phases for failed jobs.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRepairPhases

Required. Defines the types of automatic repair phases for failed jobs.

Parameter
Name Description
var array<RepairPhaseConfig>
Returns
Type Description
$this