Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / container_v1beta1.projects.locations.operations.html
blob: 2f7bf85528a2a9a2aade555b448c85c3aef99316 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#get">get(name, projectId=None, operationId=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">
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">
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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/*'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine
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.
107 "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 <code class="details" id="get">get(name, projectId=None, operationId=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.
137Specified in the format 'projects/*/locations/*/operations/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139number](https://support.google.com/cloud/answer/6158840).
140This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 operationId: string, Required. Deprecated. The server-assigned `name` of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
157 "status": "A String", # The current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "endTime": "A String", # [Output only] The time the operation completed, in
160 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
161 "name": "A String", # The server-assigned ID for the operation.
162 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]163 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
164 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "clusterConditions": [ # Which conditions caused the current cluster state.
166 { # StatusCondition describes why a cluster or a node pool has a certain status
167 # (e.g., ERROR or DEGRADED).
168 "message": "A String", # Human-friendly representation of the condition
169 "code": "A String", # Machine-friendly representation of the condition
170 },
171 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]172 "startTime": "A String", # [Output only] The time the operation started, in
173 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
174 "detail": "A String", # Detailed operation progress, if available.
175 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "operationType": "A String", # The operation type.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 "status": "A String", # Status of an operation stage.
179 # Unset for single-stage operations.
180 "metrics": [ # Progress metric bundle, for example:
181 # metrics: [{name: "nodes done", int_value: 15},
182 # {name: "nodes total", int_value: 32}]
183 # or
184 # metrics: [{name: "progress", double_value: 0.56},
185 # {name: "progress scale", double_value: 1.0}]
186 { # Progress metric is (string, int|float|string) pair.
187 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
188 "intValue": "A String", # For metrics with integer value.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 "doubleValue": 3.14, # For metrics with floating point value.
191 },
192 ],
193 "stages": [ # Substages of an operation or a stage.
194 # Object with schema name: OperationProgress
195 ],
196 "name": "A String", # A non-parameterized string describing an operation stage.
197 # Unset for single-stage operations.
198 },
199 "nodepoolConditions": [ # Which conditions caused the current node pool state.
200 { # StatusCondition describes why a cluster or a node pool has a certain status
201 # (e.g., ERROR or DEGRADED).
202 "message": "A String", # Human-friendly representation of the condition
203 "code": "A String", # Machine-friendly representation of the condition
204 },
205 ],
206 "selfLink": "A String", # Server-defined URL for the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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">
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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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, Required. 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.
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "endTime": "A String", # [Output only] The time the operation completed, in
245 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
246 "name": "A String", # The server-assigned ID for the operation.
247 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]248 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
249 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 "clusterConditions": [ # Which conditions caused the current cluster state.
251 { # StatusCondition describes why a cluster or a node pool has a certain status
252 # (e.g., ERROR or DEGRADED).
253 "message": "A String", # Human-friendly representation of the condition
254 "code": "A String", # Machine-friendly representation of the condition
255 },
256 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]257 "startTime": "A String", # [Output only] The time the operation started, in
258 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
259 "detail": "A String", # Detailed operation progress, if available.
260 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 "operationType": "A String", # The operation type.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "status": "A String", # Status of an operation stage.
264 # Unset for single-stage operations.
265 "metrics": [ # Progress metric bundle, for example:
266 # metrics: [{name: "nodes done", int_value: 15},
267 # {name: "nodes total", int_value: 32}]
268 # or
269 # metrics: [{name: "progress", double_value: 0.56},
270 # {name: "progress scale", double_value: 1.0}]
271 { # Progress metric is (string, int|float|string) pair.
272 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
273 "intValue": "A String", # For metrics with integer value.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]274 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 "doubleValue": 3.14, # For metrics with floating point value.
276 },
277 ],
278 "stages": [ # Substages of an operation or a stage.
279 # Object with schema name: OperationProgress
280 ],
281 "name": "A String", # A non-parameterized string describing an operation stage.
282 # Unset for single-stage operations.
283 },
284 "nodepoolConditions": [ # Which conditions caused the current node pool state.
285 { # StatusCondition describes why a cluster or a node pool has a certain status
286 # (e.g., ERROR or DEGRADED).
287 "message": "A String", # Human-friendly representation of the condition
288 "code": "A String", # Machine-friendly representation of the condition
289 },
290 ],
291 "selfLink": "A String", # Server-defined URL for the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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>