Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 64b25041f06b049f122bff3b67b7e0ca691fbb52 / . / docs / dyn / compute_v1.globalOperations.html
blob: 95aebbcd9bba751a390f4804b952a4f3721d2187 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.globalOperations.html">globalOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves the list of all operations grouped by scope.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, operation)</a></code></p>
85<p class="firstline">Deletes the specified operation resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, operation)</a></code></p>
88<p class="firstline">Retrieves the specified operation resource.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves the list of operation resources contained within the specified project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
98 <pre>Retrieves the list of all operations grouped by scope.
99
100Args:
101 project: string, Name of the project scoping this request. (required)
102 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
103 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
104 filter: string, Optional. Filter expression for filtering listed resources.
105
106Returns:
107 An object of the form:
108
109 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]110 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
111 "items": { # [Output Only] A map of scoped operation lists.
112 "a_key": { # [Output Only] Name of the scope containing this set of operations.
113 "operations": [ # [Output Only] List of operations contained in this scope.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]115 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
116 "clientOperationId": "A String",
117 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
118 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
119 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
120 "operationType": "A String",
121 "httpErrorMessage": "A String",
122 "progress": 42,
123 "httpErrorStatusCode": 42,
124 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
125 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
126 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
127 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 {
129 "message": "A String", # Optional human-readable details for this warning.
130 "code": "A String", # The warning type identifier for this warning.
131 "data": [ # Metadata for this warning in 'key: value' format.
132 {
133 "value": "A String", # A warning data value corresponding to the key.
134 "key": "A String", # A key for the warning data.
135 },
136 ],
137 },
138 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139 "user": "A String",
140 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
141 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
142 "name": "A String", # [Output Only] Name of the resource (output only).
143 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
144 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
145 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]147 "message": "A String", # [Output Only] An optional, human-readable error message.
148 "code": "A String", # [Output Only] The error type identifier for this error.
149 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 },
151 ],
152 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]153 "endTime": "A String",
154 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
155 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]156 },
157 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]158 "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 "message": "A String", # Optional human-readable details for this warning.
160 "code": "A String", # The warning type identifier for this warning.
161 "data": [ # Metadata for this warning in 'key: value' format.
162 {
163 "value": "A String", # A warning data value corresponding to the key.
164 "key": "A String", # A key for the warning data.
165 },
166 ],
167 },
168 },
169 },
170 "kind": "compute#operationAggregatedList", # Type of resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]171 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
172 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
178 <pre>Retrieves the next page of results.
179
180Args:
181 previous_request: The request for the previous page. (required)
182 previous_response: The response from the request for the previous page. (required)
183
184Returns:
185 A request object that you can call 'execute()' on to request the next
186 page. Returns None if there are no more items in the collection.
187 </pre>
188</div>
189
190<div class="method">
191 <code class="details" id="delete">delete(project, operation)</code>
192 <pre>Deletes the specified operation resource.
193
194Args:
195 project: string, Name of the project scoping this request. (required)
196 operation: string, Name of the operation resource to delete. (required)
197</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="get">get(project, operation)</code>
202 <pre>Retrieves the specified operation resource.
203
204Args:
205 project: string, Name of the project scoping this request. (required)
206 operation: string, Name of the operation resource to return. (required)
207
208Returns:
209 An object of the form:
210
211 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]212 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
213 "clientOperationId": "A String",
214 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
215 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
216 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
217 "operationType": "A String",
218 "httpErrorMessage": "A String",
219 "progress": 42,
220 "httpErrorStatusCode": 42,
221 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
222 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
223 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
224 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 {
226 "message": "A String", # Optional human-readable details for this warning.
227 "code": "A String", # The warning type identifier for this warning.
228 "data": [ # Metadata for this warning in 'key: value' format.
229 {
230 "value": "A String", # A warning data value corresponding to the key.
231 "key": "A String", # A key for the warning data.
232 },
233 ],
234 },
235 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]236 "user": "A String",
237 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
238 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
239 "name": "A String", # [Output Only] Name of the resource (output only).
240 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
241 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
242 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]244 "message": "A String", # [Output Only] An optional, human-readable error message.
245 "code": "A String", # [Output Only] The error type identifier for this error.
246 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]247 },
248 ],
249 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]250 "endTime": "A String",
251 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
252 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]253 }</pre>
254</div>
255
256<div class="method">
257 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
258 <pre>Retrieves the list of operation resources contained within the specified project.
259
260Args:
261 project: string, Name of the project scoping this request. (required)
262 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
263 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
264 filter: string, Optional. Filter expression for filtering listed resources.
265
266Returns:
267 An object of the form:
268
269 { # Contains a list of operation resources.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]270 "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
271 "items": [ # [Output Only] The operation resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
274 "clientOperationId": "A String",
275 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
276 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
277 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
278 "operationType": "A String",
279 "httpErrorMessage": "A String",
280 "progress": 42,
281 "httpErrorStatusCode": 42,
282 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
283 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
284 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
285 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 {
287 "message": "A String", # Optional human-readable details for this warning.
288 "code": "A String", # The warning type identifier for this warning.
289 "data": [ # Metadata for this warning in 'key: value' format.
290 {
291 "value": "A String", # A warning data value corresponding to the key.
292 "key": "A String", # A key for the warning data.
293 },
294 ],
295 },
296 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]297 "user": "A String",
298 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
299 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
300 "name": "A String", # [Output Only] Name of the resource (output only).
301 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
302 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
303 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]305 "message": "A String", # [Output Only] An optional, human-readable error message.
306 "code": "A String", # [Output Only] The error type identifier for this error.
307 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]308 },
309 ],
310 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]311 "endTime": "A String",
312 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
313 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 },
315 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]316 "kind": "compute#operationList", # Type of resource. Always compute#operations for Operations resource.
317 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
318 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]319 }</pre>
320</div>
321
322<div class="method">
323 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
324 <pre>Retrieves the next page of results.
325
326Args:
327 previous_request: The request for the previous page. (required)
328 previous_response: The response from the request for the previous page. (required)
329
330Returns:
331 A request object that you can call 'execute()' on to request the next
332 page. Returns None if there are no more items in the collection.
333 </pre>
334</div>
335
336</body></html>