Google Cloud Deploy V1 Client - Class RepairRolloutRule (0.15.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
NameDescription
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}.

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

↳ repair_modes array<Google\Cloud\Deploy\V1\RepairMode>

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

↳ condition Google\Cloud\Deploy\V1\AutomationRuleCondition

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

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getSourcePhases

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSourcePhases

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

getRepairModes

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRepairModes

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

Parameter
NameDescription
var array<Google\Cloud\Deploy\V1\RepairMode>
Returns
TypeDescription
$this

getCondition

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

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

hasCondition

clearCondition

setCondition

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

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