/
clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html
272 lines (239 loc) 路 16.4 KB
/
clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.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
<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> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html">jobRuns</a></h1>
<h2>Instance Methods</h2>
<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 JobRun.</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 JobRuns 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="#terminate">terminate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Terminates a Job Run in a given project and location.</p>
<h3>Method Details</h3>
<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 JobRun.
Args:
name: string, Required. Name of the `JobRun`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_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 `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.
"advanceChildRolloutJobRun": { # AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. # Output only. Information specific to an advanceChildRollout `JobRun`
"rollout": "A String", # Output only. Name of the `ChildRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"rolloutPhaseId": "A String", # Output only. the ID of the ChildRollout's Phase.
},
"createChildRolloutJobRun": { # CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. # Output only. Information specific to a createChildRollout `JobRun`.
"rollout": "A String", # Output only. Name of the `ChildRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"rolloutPhaseId": "A String", # Output only. The ID of the childRollout Phase initiated by this JobRun.
},
"createTime": "A String", # Output only. Time at which the `JobRun` was created.
"deployJobRun": { # DeployJobRun contains information specific to a deploy `JobRun`. # Output only. Information specific to a deploy `JobRun`.
"artifact": { # The artifacts produced by a deploy operation. # Output only. The artifact of a deploy job run, if available.
"artifactUri": "A String", # Output only. URI of a directory containing the artifacts. All paths are relative to this location.
"manifestPaths": [ # Output only. File paths of the manifests applied during the deploy operation relative to the URI.
"A String",
],
},
"build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.
"failureCause": "A String", # Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
"failureMessage": "A String", # Output only. Additional information about the deploy failure, if available.
"metadata": { # DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user. # Output only. Metadata containing information about the deploy job run.
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.
"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",
],
},
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
"etag": "A String", # Output only. 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.
"jobId": "A String", # Output only. ID of the `Rollout` job this `JobRun` corresponds to.
"name": "A String", # Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}.
"phaseId": "A String", # Output only. ID of the `Rollout` phase this `JobRun` belongs in.
"startTime": "A String", # Output only. Time at which the `JobRun` was started.
"state": "A String", # Output only. The current state of the `JobRun`.
"uid": "A String", # Output only. Unique identifier of the `JobRun`.
"verifyJobRun": { # VerifyJobRun contains information specific to a verify `JobRun`. # Output only. Information specific to a verify `JobRun`.
"artifactUri": "A String", # Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.
"build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.
"eventLogPath": "A String", # Output only. File path of the Skaffold event log relative to the artifact URI.
"failureCause": "A String", # Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.
"failureMessage": "A String", # Output only. Additional information about the verify failure, if available.
},
}</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 JobRuns in a given project and location.
Args:
parent: string, Required. The `Rollout` which owns this collection of `JobRun` objects. (required)
filter: string, Optional. Filter results 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 `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` 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 `ListJobRuns` 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:
{ # ListJobRunsResponse is the response object returned by `ListJobRuns`.
"jobRuns": [ # The `JobRun` objects.
{ # A `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.
"advanceChildRolloutJobRun": { # AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. # Output only. Information specific to an advanceChildRollout `JobRun`
"rollout": "A String", # Output only. Name of the `ChildRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"rolloutPhaseId": "A String", # Output only. the ID of the ChildRollout's Phase.
},
"createChildRolloutJobRun": { # CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. # Output only. Information specific to a createChildRollout `JobRun`.
"rollout": "A String", # Output only. Name of the `ChildRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
"rolloutPhaseId": "A String", # Output only. The ID of the childRollout Phase initiated by this JobRun.
},
"createTime": "A String", # Output only. Time at which the `JobRun` was created.
"deployJobRun": { # DeployJobRun contains information specific to a deploy `JobRun`. # Output only. Information specific to a deploy `JobRun`.
"artifact": { # The artifacts produced by a deploy operation. # Output only. The artifact of a deploy job run, if available.
"artifactUri": "A String", # Output only. URI of a directory containing the artifacts. All paths are relative to this location.
"manifestPaths": [ # Output only. File paths of the manifests applied during the deploy operation relative to the URI.
"A String",
],
},
"build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.
"failureCause": "A String", # Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
"failureMessage": "A String", # Output only. Additional information about the deploy failure, if available.
"metadata": { # DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user. # Output only. Metadata containing information about the deploy job run.
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.
"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",
],
},
},
},
"endTime": "A String", # Output only. Time at which the `JobRun` ended.
"etag": "A String", # Output only. 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.
"jobId": "A String", # Output only. ID of the `Rollout` job this `JobRun` corresponds to.
"name": "A String", # Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}.
"phaseId": "A String", # Output only. ID of the `Rollout` phase this `JobRun` belongs in.
"startTime": "A String", # Output only. Time at which the `JobRun` was started.
"state": "A String", # Output only. The current state of the `JobRun`.
"uid": "A String", # Output only. Unique identifier of the `JobRun`.
"verifyJobRun": { # VerifyJobRun contains information specific to a verify `JobRun`. # Output only. Information specific to a verify `JobRun`.
"artifactUri": "A String", # Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.
"build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.
"eventLogPath": "A String", # Output only. File path of the Skaffold event log relative to the artifact URI.
"failureCause": "A String", # Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.
"failureMessage": "A String", # Output only. Additional information about the verify failure, if available.
},
},
],
"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>
<div class="method">
<code class="details" id="terminate">terminate(name, body=None, x__xgafv=None)</code>
<pre>Terminates a Job Run in a given project and location.
Args:
name: string, Required. Name of the `JobRun`. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `TerminateJobRun`.
}
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 `TerminateJobRun`.
}</pre>
</div>
</body></html>