1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="clouddeploy_v1.html">Cloud Deploy API</a> . <a href="clouddeploy_v1.projects.html">projects</a> . <a href="clouddeploy_v1.projects.locations.html">locations</a> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.html">deliveryPipelines</a> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html">automationRuns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels an AutomationRun. The `state` of the `AutomationRun` after cancelling is `CANCELLED`. `CancelAutomationRun` can be called on AutomationRun in the state `IN_PROGRESS` and `PENDING`; AutomationRun in a different state returns an `FAILED_PRECONDITION` error.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single AutomationRun.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists AutomationRuns in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Cancels an AutomationRun. The `state` of the `AutomationRun` after cancelling is `CANCELLED`. `CancelAutomationRun` can be called on AutomationRun in the state `IN_PROGRESS` and `PENDING`; AutomationRun in a different state returns an `FAILED_PRECONDITION` error.
Args:
name: string, Required. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `CancelAutomationRun`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response object from `CancelAutomationRun`.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single AutomationRun.
Args:
name: string, Required. Name of the `AutomationRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
"advanceRolloutOperation": { # Contains the information of an automated advance-rollout operation. # Output only. Advances a rollout to the next phase.
"destinationPhase": "A String", # Output only. The phase the rollout will be advanced to.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"sourcePhase": "A String", # Output only. The phase of a deployment that initiated the operation.
"wait": "A String", # Output only. How long the operation will be paused.
},
"automationId": "A String", # Output only. The ID of the automation that initiated the operation.
"automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # Optional. The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A 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])?`.
"sourcePhases": [ # Optional. Proceeds only after phase name matched any one in the list. 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A 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
"id": "A 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])?`.
"wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A 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])?`.
"jobs": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A 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
"id": "A 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])?`.
"schedule": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Optional. Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # Optional. ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
},
"createTime": "A String", # Output only. Time at which the `AutomationRun` was created.
"etag": "A String", # Output only. The weak etag of the `AutomationRun` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"expireTime": "A String", # Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
"name": "A String", # Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
"policyViolation": { # Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why. # Output only. Contains information about what policies prevented the `AutomationRun` from proceeding.
"policyViolationDetails": [ # Policy violation details.
{ # Policy violation details.
"failureMessage": "A String", # User readable message about why the request violated a policy. This is not intended for machine parsing.
"policy": "A String", # Name of the policy that was violated. Policy resource will be in the format of `projects/{project}/locations/{location}/policies/{policy}`.
"ruleId": "A String", # Id of the rule that triggered the policy violation.
},
],
},
"promoteReleaseOperation": { # Contains the information of an automated promote-release operation. # Output only. Promotes a release to a specified 'Target'.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
"wait": "A String", # Output only. How long the operation will be paused.
},
"repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'.
"currentRepairPhaseIndex": "A String", # Output only. The index of the current repair action in the repair sequence.
"jobId": "A String", # Output only. The job ID for the Job to repair.
"phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired.
"repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
{ # RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource.
"retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode.
"attempts": [ # Output only. Detail of a retry action.
{ # RetryAttempt represents an action of retrying the failed Cloud Deploy job.
"attempt": "A String", # Output only. The index of this retry attempt.
"state": "A String", # Output only. Valid state of this retry action.
"stateDesc": "A String", # Output only. Description of the state of the Retry.
"wait": "A String", # Output only. How long the operation will be paused.
},
],
"backoffMode": "A String", # Output only. The pattern of how the wait time of the retry attempt is calculated.
"totalAttempts": "A String", # Output only. The number of attempts that have been made.
},
"rollback": { # RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'. # Output only. Rollback attempt for rollback repair mode .
"destinationPhase": "A String", # Output only. The phase to which the rollout will be rolled back to.
"disableRollbackIfRolloutPending": True or False, # Output only. If active rollout exists on the target, abort this rollback.
"rolloutId": "A String", # Output only. ID of the rollback `Rollout` to create.
"state": "A String", # Output only. Valid state of this rollback action.
"stateDesc": "A String", # Output only. Description of the state of the Rollback.
},
},
],
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
},
"ruleId": "A String", # Output only. The ID of the automation rule that initiated the operation.
"serviceAccount": "A String", # Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
"state": "A String", # Output only. Current state of the `AutomationRun`.
"stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
"targetId": "A String", # Output only. The ID of the source target that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
"timedPromoteReleaseOperation": { # Contains the information of an automated timed promote-release operation. # Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
"release": "A String", # Output only. The name of the release to be promoted.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
},
"updateTime": "A String", # Output only. Time at which the automationRun was updated.
"waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists AutomationRuns in a given project and location.
Args:
parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. (required)
filter: string, Filter automationRuns to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken: string, A page token, received from a previous `ListAutomationRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response object from `ListAutomationRuns`.
"automationRuns": [ # The `AutomationRuns` objects.
{ # An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.
"advanceRolloutOperation": { # Contains the information of an automated advance-rollout operation. # Output only. Advances a rollout to the next phase.
"destinationPhase": "A String", # Output only. The phase the rollout will be advanced to.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"sourcePhase": "A String", # Output only. The phase of a deployment that initiated the operation.
"wait": "A String", # Output only. How long the operation will be paused.
},
"automationId": "A String", # Output only. The ID of the automation that initiated the operation.
"automationSnapshot": { # An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process. # Output only. Snapshot of the Automation taken at AutomationRun creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # Optional. The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A 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])?`.
"sourcePhases": [ # Optional. Proceeds only after phase name matched any one in the list. 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A 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
"id": "A 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])?`.
"wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A 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])?`.
"jobs": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A 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
"id": "A 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])?`.
"schedule": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Optional. Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # Optional. ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
},
"createTime": "A String", # Output only. Time at which the `AutomationRun` was created.
"etag": "A String", # Output only. The weak etag of the `AutomationRun` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"expireTime": "A String", # Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.
"name": "A String", # Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
"policyViolation": { # Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why. # Output only. Contains information about what policies prevented the `AutomationRun` from proceeding.
"policyViolationDetails": [ # Policy violation details.
{ # Policy violation details.
"failureMessage": "A String", # User readable message about why the request violated a policy. This is not intended for machine parsing.
"policy": "A String", # Name of the policy that was violated. Policy resource will be in the format of `projects/{project}/locations/{location}/policies/{policy}`.
"ruleId": "A String", # Id of the rule that triggered the policy violation.
},
],
},
"promoteReleaseOperation": { # Contains the information of an automated promote-release operation. # Output only. Promotes a release to a specified 'Target'.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
"wait": "A String", # Output only. How long the operation will be paused.
},
"repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'.
"currentRepairPhaseIndex": "A String", # Output only. The index of the current repair action in the repair sequence.
"jobId": "A String", # Output only. The job ID for the Job to repair.
"phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired.
"repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
{ # RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource.
"retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode.
"attempts": [ # Output only. Detail of a retry action.
{ # RetryAttempt represents an action of retrying the failed Cloud Deploy job.
"attempt": "A String", # Output only. The index of this retry attempt.
"state": "A String", # Output only. Valid state of this retry action.
"stateDesc": "A String", # Output only. Description of the state of the Retry.
"wait": "A String", # Output only. How long the operation will be paused.
},
],
"backoffMode": "A String", # Output only. The pattern of how the wait time of the retry attempt is calculated.
"totalAttempts": "A String", # Output only. The number of attempts that have been made.
},
"rollback": { # RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'. # Output only. Rollback attempt for rollback repair mode .
"destinationPhase": "A String", # Output only. The phase to which the rollout will be rolled back to.
"disableRollbackIfRolloutPending": True or False, # Output only. If active rollout exists on the target, abort this rollback.
"rolloutId": "A String", # Output only. ID of the rollback `Rollout` to create.
"state": "A String", # Output only. Valid state of this rollback action.
"stateDesc": "A String", # Output only. Description of the state of the Rollback.
},
},
],
"rollout": "A String", # Output only. The name of the rollout that initiates the `AutomationRun`.
},
"ruleId": "A String", # Output only. The ID of the automation rule that initiated the operation.
"serviceAccount": "A String", # Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
"state": "A String", # Output only. Current state of the `AutomationRun`.
"stateDescription": "A String", # Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.
"targetId": "A String", # Output only. The ID of the source target that initiates the `AutomationRun`. The value of this field is the last segment of a target name.
"timedPromoteReleaseOperation": { # Contains the information of an automated timed promote-release operation. # Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.
"phase": "A String", # Output only. The starting phase of the rollout created by this operation.
"release": "A String", # Output only. The name of the release to be promoted.
"targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
},
"updateTime": "A String", # Output only. Time at which the automationRun was updated.
"waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
