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