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