/
clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
657 lines (593 loc) 路 41.7 KB
/
clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html
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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
<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">Google 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.releases.html">releases</a> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html">rollouts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html">jobRuns()</a></code>
</p>
<p class="firstline">Returns the jobRuns Resource.</p>
<p class="toc_element">
<code><a href="#advance">advance(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Advances a Rollout in a given project and location.</p>
<p class="toc_element">
<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Approves a Rollout.</p>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a Rollout in a given project and location.</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="#create">create(parent, body=None, requestId=None, rolloutId=None, startingPhaseId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Rollout in a given project and location.</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 Rollout.</p>
<p class="toc_element">
<code><a href="#ignoreJob">ignoreJob(rollout, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Ignores the specified Job in a Rollout.</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 Rollouts 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>
<p class="toc_element">
<code><a href="#retryJob">retryJob(rollout, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retries the specified Job in a Rollout.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="advance">advance(name, body=None, x__xgafv=None)</code>
<pre>Advances a Rollout in a given project and location.
Args:
name: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `AdvanceRollout`.
"phaseId": "A String", # Required. The phase ID to advance the `Rollout` to.
}
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 `AdvanceRollout`.
}</pre>
</div>
<div class="method">
<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
<pre>Approves a Rollout.
Args:
name: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `ApproveRollout`.
"approved": True or False, # Required. True = approve; false = reject
}
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 `ApproveRollout`.
}</pre>
</div>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Cancels a Rollout in a given project and location.
Args:
name: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `CancelRollout`.
}
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 `CancelRollout`.
}</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="create">create(parent, body=None, requestId=None, rolloutId=None, startingPhaseId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new Rollout in a given project and location.
Args:
parent: string, Required. The parent collection in which the `Rollout` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. (required)
body: object, The request body.
The object takes the form of:
{ # A `Rollout` resource in the Google Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # Labels are attributes that can be set and used by both the user and by Google 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
}
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
rolloutId: string, Required. ID of the `Rollout`.
startingPhaseId: string, Optional. The starting phase ID for the `Rollout`. If empty the `Rollout` will start at the first phase.
validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Rollout.
Args:
name: string, Required. Name of the `Rollout`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `Rollout` resource in the Google Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # Labels are attributes that can be set and used by both the user and by Google 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
}</pre>
</div>
<div class="method">
<code class="details" id="ignoreJob">ignoreJob(rollout, body=None, x__xgafv=None)</code>
<pre>Ignores the specified Job in a Rollout.
Args:
rollout: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `IgnoreJob`.
"jobId": "A String", # Required. The job ID for the Job to ignore.
"phaseId": "A String", # Required. The phase ID the Job to ignore belongs to.
}
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 `IgnoreJob`.
}</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 Rollouts in a given project and location.
Args:
parent: string, Required. The `Release` which owns this collection of `Rollout` objects. (required)
filter: string, Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. The maximum number of `Rollout` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Rollout` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken: string, Optional. A page token, received from a previous `ListRollouts` 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:
{ # ListRolloutsResponse is the response object reutrned by `ListRollouts`.
"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.
"rollouts": [ # The `Rollout` objects.
{ # A `Rollout` resource in the Google Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # Labels are attributes that can be set and used by both the user and by Google 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
},
],
"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>
<div class="method">
<code class="details" id="retryJob">retryJob(rollout, body=None, x__xgafv=None)</code>
<pre>Retries the specified Job in a Rollout.
Args:
rollout: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
body: object, The request body.
The object takes the form of:
{ # RetryJobRequest is the request object used by `RetryJob`.
"jobId": "A String", # Required. The job ID for the Job to retry.
"phaseId": "A String", # Required. The phase ID the Job to retry belongs to.
}
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 'RetryJob'.
}</pre>
</div>
</body></html>