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