Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / container_v1.projects.zones.operations.html
blob: 8f5a45dff3bb33a9c5e49d6cbdbb212056ad9df0 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.operations.html">operations</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#get">get(projectId, zone, operationId, name=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">Gets the specified operation.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="firstline">Lists all operations in a project in a specific zone or all zones.</p>
86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]88 <code class="details" id="cancel">cancel(projectId, zone, operationId, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]89 <pre>Cancels the specified operation.
90
91Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 projectId: string, Deprecated. The Google Developers Console [project ID or project
93number](https://support.google.com/cloud/answer/6158840).
94This field has been deprecated and replaced by the name field. (required)
95 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96[zone](https://cloud.google.com/compute/docs/zones#available) in which the
97operation resides. This field has been deprecated and replaced by the name
98field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 operationId: string, Deprecated. The server-assigned `name` of the operation.
100This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]102 The object takes the form of:
103
104{ # CancelOperationRequest cancels a single operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
106 # number](https://support.google.com/cloud/answer/6158840).
107 # This field has been deprecated and replaced by the name field.
108 "name": "A String", # The name (project, location, operation id) of the operation to cancel.
109 # Specified in the format 'projects/*/locations/*/operations/*'.
110 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
112 # operation resides. This field has been deprecated and replaced by the name
113 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 "operationId": "A String", # Deprecated. The server-assigned `name` of the operation.
115 # This field has been deprecated and replaced by the name field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]116 }
117
118 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]122
123Returns:
124 An object of the form:
125
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]126 { # A generic empty message that you can re-use to avoid defining duplicated
127 # empty messages in your APIs. A typical example is to use it as the request
128 # or the response type of an API method. For instance:
129 #
130 # service Foo {
131 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
132 # }
133 #
134 # The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]135 }</pre>
136</div>
137
138<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140 <pre>Gets the specified operation.
141
142Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 projectId: string, Deprecated. The Google Developers Console [project ID or project
144number](https://support.google.com/cloud/answer/6158840).
145This field has been deprecated and replaced by the name field. (required)
146 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147[zone](https://cloud.google.com/compute/docs/zones#available) in which the
148cluster resides. This field has been deprecated and replaced by the name
149field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 operationId: string, Deprecated. The server-assigned `name` of the operation.
151This field has been deprecated and replaced by the name field. (required)
152 name: string, The name (project, location, operation id) of the operation to get.
153Specified in the format 'projects/*/locations/*/operations/*'.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]158
159Returns:
160 An object of the form:
161
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]162 { # This operation resource represents operations that may have happened or are
163 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]164 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]166 "name": "A String", # The server-assigned ID for the operation.
167 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
169 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]170 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]171 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 "nodepoolConditions": [ # Which conditions caused the current node pool state.
174 { # StatusCondition describes why a cluster or a node pool has a certain status
175 # (e.g., ERROR or DEGRADED).
176 "message": "A String", # Human-friendly representation of the condition
177 "code": "A String", # Machine-friendly representation of the condition
178 },
179 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 "clusterConditions": [ # Which conditions caused the current cluster state.
181 { # StatusCondition describes why a cluster or a node pool has a certain status
182 # (e.g., ERROR or DEGRADED).
183 "message": "A String", # Human-friendly representation of the condition
184 "code": "A String", # Machine-friendly representation of the condition
185 },
186 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187 "startTime": "A String", # [Output only] The time the operation started, in
188 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
189 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
190 "status": "A String", # Status of an operation stage.
191 # Unset for single-stage operations.
192 "metrics": [ # Progress metric bundle, for example:
193 # metrics: [{name: "nodes done", int_value: 15},
194 # {name: "nodes total", int_value: 32}]
195 # or
196 # metrics: [{name: "progress", double_value: 0.56},
197 # {name: "progress scale", double_value: 1.0}]
198 { # Progress metric is (string, int|float|string) pair.
199 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
200 "intValue": "A String", # For metrics with integer value.
201 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
202 "doubleValue": 3.14, # For metrics with floating point value.
203 },
204 ],
205 "stages": [ # Substages of an operation or a stage.
206 # Object with schema name: OperationProgress
207 ],
208 "name": "A String", # A non-parameterized string describing an operation stage.
209 # Unset for single-stage operations.
210 },
211 "endTime": "A String", # [Output only] The time the operation completed, in
212 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
213 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
214 "location": "A String", # [Output only] The name of the Google Compute Engine
215 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
216 # or
217 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
218 # in which the cluster resides.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]219 }</pre>
220</div>
221
222<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]224 <pre>Lists all operations in a project in a specific zone or all zones.
225
226Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227 projectId: string, Deprecated. The Google Developers Console [project ID or project
228number](https://support.google.com/cloud/answer/6158840).
229This field has been deprecated and replaced by the parent field. (required)
230 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231[zone](https://cloud.google.com/compute/docs/zones#available) to return
232operations for, or `-` for all zones. This field has been deprecated and
233replaced by the parent field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 parent: string, The parent (project and location) where the operations will be listed.
235Specified in the format 'projects/*/locations/*'.
236Location "-" matches all zones and all regions.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]237 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241
242Returns:
243 An object of the form:
244
245 { # ListOperationsResponse is the result of ListOperationsRequest.
246 "operations": [ # A list of operations in the project in the specified zone.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]247 { # This operation resource represents operations that may have happened or are
248 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]251 "name": "A String", # The server-assigned ID for the operation.
252 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]253 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
254 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]255 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]256 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 "nodepoolConditions": [ # Which conditions caused the current node pool state.
259 { # StatusCondition describes why a cluster or a node pool has a certain status
260 # (e.g., ERROR or DEGRADED).
261 "message": "A String", # Human-friendly representation of the condition
262 "code": "A String", # Machine-friendly representation of the condition
263 },
264 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "clusterConditions": [ # Which conditions caused the current cluster state.
266 { # StatusCondition describes why a cluster or a node pool has a certain status
267 # (e.g., ERROR or DEGRADED).
268 "message": "A String", # Human-friendly representation of the condition
269 "code": "A String", # Machine-friendly representation of the condition
270 },
271 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "startTime": "A String", # [Output only] The time the operation started, in
273 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
274 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
275 "status": "A String", # Status of an operation stage.
276 # Unset for single-stage operations.
277 "metrics": [ # Progress metric bundle, for example:
278 # metrics: [{name: "nodes done", int_value: 15},
279 # {name: "nodes total", int_value: 32}]
280 # or
281 # metrics: [{name: "progress", double_value: 0.56},
282 # {name: "progress scale", double_value: 1.0}]
283 { # Progress metric is (string, int|float|string) pair.
284 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
285 "intValue": "A String", # For metrics with integer value.
286 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
287 "doubleValue": 3.14, # For metrics with floating point value.
288 },
289 ],
290 "stages": [ # Substages of an operation or a stage.
291 # Object with schema name: OperationProgress
292 ],
293 "name": "A String", # A non-parameterized string describing an operation stage.
294 # Unset for single-stage operations.
295 },
296 "endTime": "A String", # [Output only] The time the operation completed, in
297 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
298 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
299 "location": "A String", # [Output only] The name of the Google Compute Engine
300 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
301 # or
302 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
303 # in which the cluster resides.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]304 },
305 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]306 "missingZones": [ # If any zones are listed here, the list of operations returned
307 # may be missing the operations from those zones.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]308 "A String",
309 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]310 }</pre>
311</div>
312
313</body></html>