Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / container_v1beta1.projects.zones.operations.html
blob: a6dd83c005f6c9d0b48af6be3d33d2a581dabbba [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
75<h1><a href="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.operations.html">operations</a></h1>
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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
81 <code><a href="#get">get(projectId, zone, operationId, name=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the specified operation.</p>
83<p class="toc_element">
84 <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists all operations in a project in the specified 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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <pre>Cancels the specified operation.
90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]92 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93number](https://support.google.com/cloud/answer/6158840).
94This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95 zone: string, Required. Deprecated. The name of the Google Compute Engine
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)
99 operationId: string, Required. Deprecated. The server-assigned `name` of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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;, # Required. 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;, # Required. 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;, # Required. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 }
117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
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 `{}`.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code>
140 <pre>Gets the specified operation.
141
142Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144number](https://support.google.com/cloud/answer/6158840).
145This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146 zone: string, Required. Deprecated. The name of the Google Compute Engine
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)
150 operationId: string, Required. Deprecated. The server-assigned `name` of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
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;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 { # StatusCondition describes why a cluster or a node pool has a certain status
166 # (e.g., ERROR or DEGRADED).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]167 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
168 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 },
170 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]171 &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]172 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
173 # or
174 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
175 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]176 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
177 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
178 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
179 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
180 &quot;clusterConditions&quot;: [ # 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 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
184 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
185 },
186 ],
187 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
188 &quot;stages&quot;: [ # Substages of an operation or a stage.
189 # Object with schema name: OperationProgress
190 ],
191 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
192 # Unset for single-stage operations.
193 &quot;metrics&quot;: [ # Progress metric bundle, for example:
194 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
195 # {name: &quot;nodes total&quot;, int_value: 32}]
196 # or
197 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
198 # {name: &quot;progress scale&quot;, double_value: 1.0}]
199 { # Progress metric is (string, int|float|string) pair.
200 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
201 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
202 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
203 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
204 },
205 ],
206 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
207 # Unset for single-stage operations.
208 },
209 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
210 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
211 # operation is taking place. This field is deprecated, use location instead.
212 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
213 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
214 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
215 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
216 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
217 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
218 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>
224 <pre>Lists all operations in a project in the specified zone or all zones.
225
226Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228number](https://support.google.com/cloud/answer/6158840).
229This field has been deprecated and replaced by the parent field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]230 zone: string, Required. Deprecated. The name of the Google Compute Engine
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 { # StatusCondition describes why a cluster or a node pool has a certain status
251 # (e.g., ERROR or DEGRADED).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]252 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
253 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 },
255 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]256 &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]257 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
258 # or
259 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
260 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]261 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
262 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
263 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
264 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
265 &quot;clusterConditions&quot;: [ # 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 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
269 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
270 },
271 ],
272 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
273 &quot;stages&quot;: [ # Substages of an operation or a stage.
274 # Object with schema name: OperationProgress
275 ],
276 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
277 # Unset for single-stage operations.
278 &quot;metrics&quot;: [ # Progress metric bundle, for example:
279 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
280 # {name: &quot;nodes total&quot;, int_value: 32}]
281 # or
282 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
283 # {name: &quot;progress scale&quot;, double_value: 1.0}]
284 { # Progress metric is (string, int|float|string) pair.
285 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
286 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
287 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
288 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
289 },
290 ],
291 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
292 # Unset for single-stage operations.
293 },
294 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
295 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
296 # operation is taking place. This field is deprecated, use location instead.
297 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
298 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
299 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
300 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
301 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
302 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
303 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 ],
310 }</pre>
311</div>
312
313</body></html>