Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_alpha.globalOperations.html
blob: 339212dae38d040fbad09e59ac5cea6feccbac32 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalOperations.html">globalOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves an aggregated list of all operations.</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 Operations resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, operation)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Retrieves the specified Operations resource. Gets a list of operations by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves a 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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#wait">wait(project, operation)</a></code></p>
97<p class="firstline">Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
101 <pre>Retrieves an aggregated list of all operations.
102
103Args:
104 project: string, Project ID for this request. (required)
105 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
106
107You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
108
109Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]111 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]113
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]117
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119
120Returns:
121 An object of the form:
122
123 {
124 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]126 "items": { # [Output Only] A map of scoped operation lists.
127 "a_key": { # [Output Only] Name of the scope containing this set of operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 "operations": [ # [Output Only] A list of operations contained in this scope.
129 { # Represents an Operation resource.
130 #
131 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
132 #
133 # Operations can be global, regional or zonal.
134 # - For global operations, use the globalOperations resource.
135 # - For regional operations, use the regionOperations resource.
136 # - For zonal operations, use the zonalOperations resource.
137 #
138 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]139 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]141 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]142 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]144 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
145 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
146 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
147 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
148 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
149 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
150 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
151 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
152 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
153 {
154 "message": "A String", # [Output Only] A human-readable description of the warning code.
155 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
156 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
157 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
158 {
159 "value": "A String", # [Output Only] A warning data value corresponding to the key.
160 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
161 },
162 ],
163 },
164 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]166 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
167 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
168 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
169 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]171 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
172 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
173 {
174 "message": "A String", # [Output Only] An optional, human-readable error message.
175 "code": "A String", # [Output Only] The error type identifier for this error.
176 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
177 },
178 ],
179 },
180 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
181 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]182 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183 },
184 ],
185 "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
186 "message": "A String", # [Output Only] A human-readable description of the warning code.
187 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
188 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
189 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
190 {
191 "value": "A String", # [Output Only] A warning data value corresponding to the key.
192 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
193 },
194 ],
195 },
196 },
197 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 "warning": { # [Output Only] Informational warning message.
199 "message": "A String", # [Output Only] A human-readable description of the warning code.
200 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
201 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
202 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
203 {
204 "value": "A String", # [Output Only] A warning data value corresponding to the key.
205 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
206 },
207 ],
208 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]209 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
210 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
211 }</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
216 <pre>Retrieves the next page of results.
217
218Args:
219 previous_request: The request for the previous page. (required)
220 previous_response: The response from the request for the previous page. (required)
221
222Returns:
223 A request object that you can call 'execute()' on to request the next
224 page. Returns None if there are no more items in the collection.
225 </pre>
226</div>
227
228<div class="method">
229 <code class="details" id="delete">delete(project, operation)</code>
230 <pre>Deletes the specified Operations resource.
231
232Args:
233 project: string, Project ID for this request. (required)
234 operation: string, Name of the Operations resource to delete. (required)
235</pre>
236</div>
237
238<div class="method">
239 <code class="details" id="get">get(project, operation)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 <pre>Retrieves the specified Operations resource. Gets a list of operations by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]241
242Args:
243 project: string, Project ID for this request. (required)
244 operation: string, Name of the Operations resource to return. (required)
245
246Returns:
247 An object of the form:
248
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 { # Represents an Operation resource.
250 #
251 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
252 #
253 # Operations can be global, regional or zonal.
254 # - For global operations, use the globalOperations resource.
255 # - For regional operations, use the regionOperations resource.
256 # - For zonal operations, use the zonalOperations resource.
257 #
258 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]259 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]261 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]262 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]264 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
265 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
266 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
267 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
268 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
269 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
270 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
271 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
272 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
273 {
274 "message": "A String", # [Output Only] A human-readable description of the warning code.
275 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
276 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
277 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
278 {
279 "value": "A String", # [Output Only] A warning data value corresponding to the key.
280 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
281 },
282 ],
283 },
284 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]286 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
287 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
288 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
289 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]291 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
292 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
293 {
294 "message": "A String", # [Output Only] An optional, human-readable error message.
295 "code": "A String", # [Output Only] The error type identifier for this error.
296 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
297 },
298 ],
299 },
300 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
301 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]302 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]303 }</pre>
304</div>
305
306<div class="method">
307 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
308 <pre>Retrieves a list of Operation resources contained within the specified project.
309
310Args:
311 project: string, Project ID for this request. (required)
312 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
313
314You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
315
316Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]317 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]318 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]320
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]321For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]322
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]323You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]324
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]326
327Returns:
328 An object of the form:
329
330 { # Contains a list of Operation resources.
331 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333 "items": [ # [Output Only] A list of Operation resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 { # Represents an Operation resource.
335 #
336 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
337 #
338 # Operations can be global, regional or zonal.
339 # - For global operations, use the globalOperations resource.
340 # - For regional operations, use the regionOperations resource.
341 # - For zonal operations, use the zonalOperations resource.
342 #
343 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]344 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]346 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]347 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]349 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
350 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
351 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
352 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
353 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
354 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
355 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
356 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
357 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
358 {
359 "message": "A String", # [Output Only] A human-readable description of the warning code.
360 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
361 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
362 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
363 {
364 "value": "A String", # [Output Only] A warning data value corresponding to the key.
365 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
366 },
367 ],
368 },
369 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
372 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
373 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
374 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]376 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
377 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
378 {
379 "message": "A String", # [Output Only] An optional, human-readable error message.
380 "code": "A String", # [Output Only] The error type identifier for this error.
381 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
382 },
383 ],
384 },
385 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
386 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]387 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]388 },
389 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 "warning": { # [Output Only] Informational warning message.
391 "message": "A String", # [Output Only] A human-readable description of the warning code.
392 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
393 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
394 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
395 {
396 "value": "A String", # [Output Only] A warning data value corresponding to the key.
397 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
398 },
399 ],
400 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]401 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
402 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
403 }</pre>
404</div>
405
406<div class="method">
407 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
408 <pre>Retrieves the next page of results.
409
410Args:
411 previous_request: The request for the previous page. (required)
412 previous_response: The response from the request for the previous page. (required)
413
414Returns:
415 A request object that you can call 'execute()' on to request the next
416 page. Returns None if there are no more items in the collection.
417 </pre>
418</div>
419
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420<div class="method">
421 <code class="details" id="wait">wait(project, operation)</code>
422 <pre>Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE.
423
424Args:
425 project: string, Project ID for this request. (required)
426 operation: string, Name of the Operations resource to return. (required)
427
428Returns:
429 An object of the form:
430
431 { # Represents an Operation resource.
432 #
433 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
434 #
435 # Operations can be global, regional or zonal.
436 # - For global operations, use the globalOperations resource.
437 # - For regional operations, use the regionOperations resource.
438 # - For zonal operations, use the zonalOperations resource.
439 #
440 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
441 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
442 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
443 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
444 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
445 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
446 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
447 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
448 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
449 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
450 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
451 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
452 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
453 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
454 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
455 {
456 "message": "A String", # [Output Only] A human-readable description of the warning code.
457 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
458 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
459 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
460 {
461 "value": "A String", # [Output Only] A warning data value corresponding to the key.
462 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
463 },
464 ],
465 },
466 ],
467 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
468 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
469 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
470 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
471 "name": "A String", # [Output Only] Name of the resource.
472 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
473 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
474 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
475 {
476 "message": "A String", # [Output Only] An optional, human-readable error message.
477 "code": "A String", # [Output Only] The error type identifier for this error.
478 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
479 },
480 ],
481 },
482 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
483 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
484 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
485 }</pre>
486</div>
487
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]488</body></html>