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