Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / container_v1.projects.locations.operations.html
blob: 0e73406d9eb4f0ee3d8cc019b061bb3cd661c74f [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#get">get(name, operationId=None, projectId=None, zone=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Gets the specified operation.</p>
83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#list">list(parent, projectId=None, zone=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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
100 # operation resides. This field has been deprecated and replaced by the name
101 # field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project
103 # number](https://support.google.com/cloud/answer/6158840).
104 # This field has been deprecated and replaced by the name field.
105 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, operation id) of the operation to cancel.
106 # Specified in the format `projects/*/locations/*/operations/*`.
107 &quot;operationId&quot;: &quot;A String&quot;, # Deprecated. The server-assigned `name` of the operation.
108 # This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 <code class="details" id="get">get(name, operationId=None, projectId=None, zone=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 <pre>Gets the specified operation.
134
135Args:
136 name: string, The name (project, location, operation id) of the operation to get.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137Specified in the format `projects/*/locations/*/operations/*`. (required)
138 operationId: string, Deprecated. The server-assigned `name` of the operation.
139This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 projectId: string, Deprecated. The Google Developers Console [project ID or project
141number](https://support.google.com/cloud/answer/6158840).
142This field has been deprecated and replaced by the name field.
143 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144[zone](https://cloud.google.com/compute/docs/zones#available) in which the
145cluster resides. This field has been deprecated and replaced by the name
146field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]157 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
158 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
159 # Unset for single-stage operations.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 &quot;metrics&quot;: [ # Progress metric bundle, for example:
161 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
162 # {name: &quot;nodes total&quot;, int_value: 32}]
163 # or
164 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
165 # {name: &quot;progress scale&quot;, double_value: 1.0}]
166 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]167 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]168 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
169 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]170 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]171 },
172 ],
173 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
174 # Unset for single-stage operations.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]175 &quot;stages&quot;: [ # Substages of an operation or a stage.
176 # Object with schema name: OperationProgress
177 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]178 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]179 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
180 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
181 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
182 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
183 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
184 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
185 { # StatusCondition describes why a cluster or a node pool has a certain status
186 # (e.g., ERROR or DEGRADED).
187 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
188 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
189 },
190 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]191 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
192 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
193 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]194 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]196 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
197 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
198 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 { # StatusCondition describes why a cluster or a node pool has a certain status
201 # (e.g., ERROR or DEGRADED).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]202 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]203 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 },
205 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]207 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
208 # or
209 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
210 # in which the cluster resides.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]211 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 }</pre>
213</div>
214
215<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 <code class="details" id="list">list(parent, projectId=None, zone=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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221Specified in the format `projects/*/locations/*`.
222Location &quot;-&quot; 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]226 zone: string, Deprecated. The name of the Google Compute Engine
227[zone](https://cloud.google.com/compute/docs/zones#available) to return
228operations for, or `-` for all zones. This field has been deprecated and
229replaced 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 &quot;operations&quot;: [ # A list of operations in the project in the specified zone.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 { # This operation resource represents operations that may have happened or are
241 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]242 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
243 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
244 # Unset for single-stage operations.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]245 &quot;metrics&quot;: [ # Progress metric bundle, for example:
246 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
247 # {name: &quot;nodes total&quot;, int_value: 32}]
248 # or
249 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
250 # {name: &quot;progress scale&quot;, double_value: 1.0}]
251 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]252 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]253 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
254 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]255 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]256 },
257 ],
258 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
259 # Unset for single-stage operations.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]260 &quot;stages&quot;: [ # Substages of an operation or a stage.
261 # Object with schema name: OperationProgress
262 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]263 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]264 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
265 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
266 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
267 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
268 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
269 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
270 { # StatusCondition describes why a cluster or a node pool has a certain status
271 # (e.g., ERROR or DEGRADED).
272 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
273 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
274 },
275 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]276 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
277 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
278 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]279 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]280 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]281 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
282 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
283 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 { # StatusCondition describes why a cluster or a node pool has a certain status
286 # (e.g., ERROR or DEGRADED).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]287 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]288 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 },
290 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]292 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
293 # or
294 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
295 # in which the cluster resides.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]296 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 },
298 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]299 &quot;missingZones&quot;: [ # If any zones are listed here, the list of operations returned
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 # may be missing the operations from those zones.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 ],
303 }</pre>
304</div>
305
306</body></html>