Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / container_v1.projects.zones.operations.html
blob: ea6129bd1a68b9fd1d3792a2dc52e7b6f0054bd7 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]75<h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.operations.html">operations</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="#cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels the specified operation.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]81 <code><a href="#get">get(projectId, zone, operationId, name=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">Gets the specified operation.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]84 <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88 <code class="details" id="cancel">cancel(projectId, zone, operationId, body, x__xgafv=None)</code>
89 <pre>Cancels the specified operation.
90
91Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]92 projectId: string, Deprecated. The Google Developers Console [project ID or project
93number](https://support.google.com/cloud/answer/6158840).
94This field has been deprecated and replaced by the name field. (required)
95 zone: string, Deprecated. The name of the Google Compute Engine
96[zone](/compute/docs/zones#available) in which the operation resides.
97This field has been deprecated and replaced by the name field. (required)
98 operationId: string, Deprecated. The server-assigned `name` of the operation.
99This field has been deprecated and replaced by the name field. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 body: object, The request body. (required)
101 The object takes the form of:
102
103{ # CancelOperationRequest cancels a single operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]104 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
105 # number](https://support.google.com/cloud/answer/6158840).
106 # This field has been deprecated and replaced by the name field.
107 "name": "A String", # The name (project, location, operation id) of the operation to cancel.
108 # Specified in the format 'projects/*/locations/*/operations/*'.
109 "zone": "A String", # Deprecated. The name of the Google Compute Engine
110 # [zone](/compute/docs/zones#available) in which the operation resides.
111 # This field has been deprecated and replaced by the name field.
112 "operationId": "A String", # Deprecated. The server-assigned `name` of the operation.
113 # This field has been deprecated and replaced by the name field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]114 }
115
116 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120
121Returns:
122 An object of the form:
123
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]124 { # A generic empty message that you can re-use to avoid defining duplicated
125 # empty messages in your APIs. A typical example is to use it as the request
126 # or the response type of an API method. For instance:
127 #
128 # service Foo {
129 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
130 # }
131 #
132 # The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]133 }</pre>
134</div>
135
136<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]137 <code class="details" id="get">get(projectId, zone, operationId, name=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138 <pre>Gets the specified operation.
139
140Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]141 projectId: string, Deprecated. The Google Developers Console [project ID or project
142number](https://support.google.com/cloud/answer/6158840).
143This field has been deprecated and replaced by the name field. (required)
144 zone: string, Deprecated. The name of the Google Compute Engine
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]145[zone](/compute/docs/zones#available) in which the cluster
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]146resides.
147This field has been deprecated and replaced by the name field. (required)
148 operationId: string, Deprecated. The server-assigned `name` of the operation.
149This field has been deprecated and replaced by the name field. (required)
150 name: string, The name (project, location, operation id) of the operation to get.
151Specified in the format 'projects/*/locations/*/operations/*'.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]156
157Returns:
158 An object of the form:
159
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]160 { # This operation resource represents operations that may have happened or are
161 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]162 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]163 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]164 "name": "A String", # The server-assigned ID for the operation.
165 "zone": "A String", # The name of the Google Compute Engine
166 # [zone](/compute/docs/zones#available) in which the operation
167 # is taking place.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]168 # This field is deprecated, use location instead.
169 "startTime": "A String", # [Output only] The time the operation started, in
170 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]171 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]172 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]173 "targetLink": "A String", # Server-defined URL for the target of the operation.
174 "location": "A String", # [Output only] The name of the Google Compute Engine
175 # [zone](/compute/docs/regions-zones/regions-zones#available) or
176 # [region](/compute/docs/regions-zones/regions-zones#available) in which
177 # the cluster resides.
178 "nodepoolConditions": [ # Which conditions caused the current node pool state.
179 { # StatusCondition describes why a cluster or a node pool has a certain status
180 # (e.g., ERROR or DEGRADED).
181 "message": "A String", # Human-friendly representation of the condition
182 "code": "A String", # Machine-friendly representation of the condition
183 },
184 ],
185 "endTime": "A String", # [Output only] The time the operation completed, in
186 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
187 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
188 "clusterConditions": [ # Which conditions caused the current cluster state.
189 { # StatusCondition describes why a cluster or a node pool has a certain status
190 # (e.g., ERROR or DEGRADED).
191 "message": "A String", # Human-friendly representation of the condition
192 "code": "A String", # Machine-friendly representation of the condition
193 },
194 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 }</pre>
196</div>
197
198<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]199 <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]200 <pre>Lists all operations in a project in a specific zone or all zones.
201
202Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]203 projectId: string, Deprecated. The Google Developers Console [project ID or project
204number](https://support.google.com/cloud/answer/6158840).
205This field has been deprecated and replaced by the parent field. (required)
206 zone: string, Deprecated. The name of the Google Compute Engine
207[zone](/compute/docs/zones#available) to return operations for, or `-` for
208all zones. This field has been deprecated and replaced by the parent field. (required)
209 parent: string, The parent (project and location) where the operations will be listed.
210Specified in the format 'projects/*/locations/*'.
211Location "-" matches all zones and all regions.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]212 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]216
217Returns:
218 An object of the form:
219
220 { # ListOperationsResponse is the result of ListOperationsRequest.
221 "operations": [ # A list of operations in the project in the specified zone.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]222 { # This operation resource represents operations that may have happened or are
223 # happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]224 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]225 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]226 "name": "A String", # The server-assigned ID for the operation.
227 "zone": "A String", # The name of the Google Compute Engine
228 # [zone](/compute/docs/zones#available) in which the operation
229 # is taking place.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]230 # This field is deprecated, use location instead.
231 "startTime": "A String", # [Output only] The time the operation started, in
232 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]233 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]234 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]235 "targetLink": "A String", # Server-defined URL for the target of the operation.
236 "location": "A String", # [Output only] The name of the Google Compute Engine
237 # [zone](/compute/docs/regions-zones/regions-zones#available) or
238 # [region](/compute/docs/regions-zones/regions-zones#available) in which
239 # the cluster resides.
240 "nodepoolConditions": [ # Which conditions caused the current node pool state.
241 { # StatusCondition describes why a cluster or a node pool has a certain status
242 # (e.g., ERROR or DEGRADED).
243 "message": "A String", # Human-friendly representation of the condition
244 "code": "A String", # Machine-friendly representation of the condition
245 },
246 ],
247 "endTime": "A String", # [Output only] The time the operation completed, in
248 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
249 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]257 },
258 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]259 "missingZones": [ # If any zones are listed here, the list of operations returned
260 # may be missing the operations from those zones.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]261 "A String",
262 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]263 }</pre>
264</div>
265
266</body></html>