Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / container_v1beta1.projects.zones.operations.html
blob: d72f2ec69751c357c173f445bd04d6d92803ef93 [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">
78 <code><a href="#cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</a></code></p>
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">
88 <code class="details" id="cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</code>
89 <pre>Cancels the specified operation.
90
91Args:
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
96[zone](/compute/docs/zones#available) in which the operation resides.
97This field has been deprecated and replaced by the name field. (required)
98 operationId: string, Deprecated. The server-assigned `name` of the operation.
99This field has been deprecated and replaced by the name field. (required)
100 body: object, The request body. (required)
101 The object takes the form of:
102
103{ # CancelOperationRequest cancels a single operation.
104 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
105 # number](https://support.google.com/cloud/answer/6158840).
106 # This field has been deprecated and replaced by the name field.
107 "name": "A String", # The name (project, location, operation id) of the operation to cancel.
108 # Specified in the format 'projects/*/locations/*/operations/*'.
109 "zone": "A String", # Deprecated. The name of the Google Compute Engine
110 # [zone](/compute/docs/zones#available) in which the operation resides.
111 # This field has been deprecated and replaced by the name field.
112 "operationId": "A String", # Deprecated. The server-assigned `name` of the operation.
113 # This field has been deprecated and replaced by the name field.
114 }
115
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121Returns:
122 An object of the form:
123
124 { # A generic empty message that you can re-use to avoid defining duplicated
125 # empty messages in your APIs. A typical example is to use it as the request
126 # or the response type of an API method. For instance:
127 #
128 # service Foo {
129 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
130 # }
131 #
132 # The JSON representation for `Empty` is empty JSON object `{}`.
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code>
138 <pre>Gets the specified operation.
139
140Args:
141 projectId: string, Deprecated. The Google Developers Console [project ID or project
142number](https://support.google.com/cloud/answer/6158840).
143This field has been deprecated and replaced by the name field. (required)
144 zone: string, Deprecated. The name of the Google Compute Engine
145[zone](/compute/docs/zones#available) in which the cluster
146resides.
147This field has been deprecated and replaced by the name field. (required)
148 operationId: string, Deprecated. The server-assigned `name` of the operation.
149This field has been deprecated and replaced by the name field. (required)
150 name: string, The name (project, location, operation id) of the operation to get.
151Specified in the format 'projects/*/locations/*/operations/*'.
152 x__xgafv: string, V1 error format.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
156
157Returns:
158 An object of the form:
159
160 { # This operation resource represents operations that may have happened or are
161 # happening on the cluster. All fields are output only.
162 "status": "A String", # The current status of the operation.
163 "endTime": "A String", # [Output only] The time the operation completed, in
164 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
165 "name": "A String", # The server-assigned ID for the operation.
166 "zone": "A String", # The name of the Google Compute Engine
167 # [zone](/compute/docs/zones#available) in which the operation
168 # is taking place.
169 # This field is deprecated, use location instead.
170 "location": "A String", # [Output only] The name of the Google Compute Engine
171 # [zone](/compute/docs/regions-zones/regions-zones#available) or
172 # [region](/compute/docs/regions-zones/regions-zones#available) in which
173 # the cluster resides.
174 "startTime": "A String", # [Output only] The time the operation started, in
175 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
176 "detail": "A String", # Detailed operation progress, if available.
177 "clusterConditions": [ # Which conditions caused the current cluster state.
178 { # StatusCondition describes why a cluster or a node pool has a certain status
179 # (e.g., ERROR or DEGRADED).
180 "message": "A String", # Human-friendly representation of the condition
181 "code": "A String", # Machine-friendly representation of the condition
182 },
183 ],
184 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
185 "operationType": "A String", # The operation type.
186 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
187 "status": "A String", # Status of an operation stage.
188 # Unset for single-stage operations.
189 "metrics": [ # Progress metric bundle, for example:
190 # metrics: [{name: "nodes done", int_value: 15},
191 # {name: "nodes total", int_value: 32}]
192 # or
193 # metrics: [{name: "progress", double_value: 0.56},
194 # {name: "progress scale", double_value: 1.0}]
195 { # Progress metric is (string, int|float|string) pair.
196 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
197 "intValue": "A String", # For metrics with integer value.
198 "name": "A String", # Metric name, required.
199 # e.g., "nodes total", "percent done"
200 "doubleValue": 3.14, # For metrics with floating point value.
201 },
202 ],
203 "stages": [ # Substages of an operation or a stage.
204 # Object with schema name: OperationProgress
205 ],
206 "name": "A String", # A non-parameterized string describing an operation stage.
207 # Unset for single-stage operations.
208 },
209 "nodepoolConditions": [ # Which conditions caused the current node pool state.
210 { # StatusCondition describes why a cluster or a node pool has a certain status
211 # (e.g., ERROR or DEGRADED).
212 "message": "A String", # Human-friendly representation of the condition
213 "code": "A String", # Machine-friendly representation of the condition
214 },
215 ],
216 "selfLink": "A String", # Server-defined URL for the resource.
217 "targetLink": "A String", # Server-defined URL for the target of the operation.
218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>
223 <pre>Lists all operations in a project in the specified zone or all zones.
224
225Args:
226 projectId: string, Deprecated. The Google Developers Console [project ID or project
227number](https://support.google.com/cloud/answer/6158840).
228This field has been deprecated and replaced by the parent field. (required)
229 zone: string, Deprecated. The name of the Google Compute Engine
230[zone](/compute/docs/zones#available) to return operations for, or `-` for
231all zones. This field has been deprecated and replaced by the parent field. (required)
232 parent: string, The parent (project and location) where the operations will be listed.
233Specified in the format 'projects/*/locations/*'.
234Location "-" matches all zones and all regions.
235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
243 { # ListOperationsResponse is the result of ListOperationsRequest.
244 "operations": [ # A list of operations in the project in the specified zone.
245 { # This operation resource represents operations that may have happened or are
246 # happening on the cluster. All fields are output only.
247 "status": "A String", # The current status of the operation.
248 "endTime": "A String", # [Output only] The time the operation completed, in
249 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
250 "name": "A String", # The server-assigned ID for the operation.
251 "zone": "A String", # The name of the Google Compute Engine
252 # [zone](/compute/docs/zones#available) in which the operation
253 # is taking place.
254 # This field is deprecated, use location instead.
255 "location": "A String", # [Output only] The name of the Google Compute Engine
256 # [zone](/compute/docs/regions-zones/regions-zones#available) or
257 # [region](/compute/docs/regions-zones/regions-zones#available) in which
258 # the cluster resides.
259 "startTime": "A String", # [Output only] The time the operation started, in
260 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
261 "detail": "A String", # Detailed operation progress, if available.
262 "clusterConditions": [ # Which conditions caused the current cluster state.
263 { # StatusCondition describes why a cluster or a node pool has a certain status
264 # (e.g., ERROR or DEGRADED).
265 "message": "A String", # Human-friendly representation of the condition
266 "code": "A String", # Machine-friendly representation of the condition
267 },
268 ],
269 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
270 "operationType": "A String", # The operation type.
271 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
272 "status": "A String", # Status of an operation stage.
273 # Unset for single-stage operations.
274 "metrics": [ # Progress metric bundle, for example:
275 # metrics: [{name: "nodes done", int_value: 15},
276 # {name: "nodes total", int_value: 32}]
277 # or
278 # metrics: [{name: "progress", double_value: 0.56},
279 # {name: "progress scale", double_value: 1.0}]
280 { # Progress metric is (string, int|float|string) pair.
281 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
282 "intValue": "A String", # For metrics with integer value.
283 "name": "A String", # Metric name, required.
284 # e.g., "nodes total", "percent done"
285 "doubleValue": 3.14, # For metrics with floating point value.
286 },
287 ],
288 "stages": [ # Substages of an operation or a stage.
289 # Object with schema name: OperationProgress
290 ],
291 "name": "A String", # A non-parameterized string describing an operation stage.
292 # Unset for single-stage operations.
293 },
294 "nodepoolConditions": [ # Which conditions caused the current node pool state.
295 { # StatusCondition describes why a cluster or a node pool has a certain status
296 # (e.g., ERROR or DEGRADED).
297 "message": "A String", # Human-friendly representation of the condition
298 "code": "A String", # Machine-friendly representation of the condition
299 },
300 ],
301 "selfLink": "A String", # Server-defined URL for the resource.
302 "targetLink": "A String", # Server-defined URL for the target of the operation.
303 },
304 ],
305 "missingZones": [ # If any zones are listed here, the list of operations returned
306 # may be missing the operations from those zones.
307 "A String",
308 ],
309 }</pre>
310</div>
311
312</body></html>