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