Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / container_v1.projects.zones.operations.html
blob: 94444eae4124a1f47a33ad99a8ab32056f493841 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]105 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, operation id) of the operation to cancel.
106 # Specified in the format `projects/*/locations/*/operations/*`.
107 &quot;operationId&quot;: &quot;A String&quot;, # Deprecated. The server-assigned `name` of the operation.
108 # This field has been deprecated and replaced by the name field.
109 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 # number](https://support.google.com/cloud/answer/6158840).
111 # This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]112 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
114 # operation resides. This field has been deprecated and replaced by the name
115 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]164 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
165 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 { # StatusCondition describes why a cluster or a node pool has a certain status
167 # (e.g., ERROR or DEGRADED).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]168 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
169 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 },
171 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]172 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]173 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]174 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]175 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
176 # or
177 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
178 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]179 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
180 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
181 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
182 &quot;stages&quot;: [ # Substages of an operation or a stage.
183 # Object with schema name: OperationProgress
184 ],
185 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
186 # Unset for single-stage operations.
187 &quot;metrics&quot;: [ # Progress metric bundle, for example:
188 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
189 # {name: &quot;nodes total&quot;, int_value: 32}]
190 # or
191 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
192 # {name: &quot;progress scale&quot;, double_value: 1.0}]
193 { # Progress metric is (string, int|float|string) pair.
194 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
195 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
196 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
197 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
198 },
199 ],
200 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
201 # Unset for single-stage operations.
202 },
203 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
204 { # StatusCondition describes why a cluster or a node pool has a certain status
205 # (e.g., ERROR or DEGRADED).
206 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
207 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
208 },
209 ],
210 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
211 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
212 # operation is taking place. This field is deprecated, use location instead.
213 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
214 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
215 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
216 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
217 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
218 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]235Specified in the format `projects/*/locations/*`.
236Location &quot;-&quot; 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]246 &quot;operations&quot;: [ # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]249 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
250 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 { # StatusCondition describes why a cluster or a node pool has a certain status
252 # (e.g., ERROR or DEGRADED).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]253 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
254 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 },
256 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]257 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]258 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]259 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]260 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
261 # or
262 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
263 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]264 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
265 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
266 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
267 &quot;stages&quot;: [ # Substages of an operation or a stage.
268 # Object with schema name: OperationProgress
269 ],
270 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
271 # Unset for single-stage operations.
272 &quot;metrics&quot;: [ # Progress metric bundle, for example:
273 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
274 # {name: &quot;nodes total&quot;, int_value: 32}]
275 # or
276 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
277 # {name: &quot;progress scale&quot;, double_value: 1.0}]
278 { # Progress metric is (string, int|float|string) pair.
279 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
280 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
281 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
282 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
283 },
284 ],
285 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
286 # Unset for single-stage operations.
287 },
288 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
289 { # StatusCondition describes why a cluster or a node pool has a certain status
290 # (e.g., ERROR or DEGRADED).
291 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
292 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
293 },
294 ],
295 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
296 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
297 # operation is taking place. This field is deprecated, use location instead.
298 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
299 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
300 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
301 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
302 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
303 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]304 },
305 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]306 &quot;missingZones&quot;: [ # If any zones are listed here, the list of operations returned
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]307 # may be missing the operations from those zones.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]308 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]309 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]310 }</pre>
311</div>
312
313</body></html>