Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_v1.globalOperations.html
blob: f4caddf16ae97e52c8fac00c1b913c5ab6d9805b [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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Retrieves an aggregated list of all operations.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="firstline">Deletes the specified Operations resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Retrieves a list of Operation resources contained within the specified project.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]97 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]98 <pre>Retrieves an aggregated list of all operations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99
100Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]102 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
103
104You 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.
105
106Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]107 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 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]109 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 <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115To 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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116
117Returns:
118 An object of the form:
119
120 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121 "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]122 "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123 "items": { # [Output Only] A map of scoped operation lists.
124 "a_key": { # [Output Only] Name of the scope containing this set of operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 "operations": [ # [Output Only] A list of operations contained in this scope.
126 { # Represents an Operation resource.
127 #
128 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
129 #
130 # Operations can be global, regional or zonal.
131 # - For global operations, use the globalOperations resource.
132 # - For regional operations, use the regionOperations resource.
133 # - For zonal operations, use the zonalOperations resource.
134 #
135 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]136 "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]137 "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]138 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]139 "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]140 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]141 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
142 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 "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.
145 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
148 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]149 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]151 "message": "A String", # [Output Only] A human-readable description of the warning code.
152 "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.
153 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
154 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]156 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]157 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 },
159 ],
160 },
161 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]162 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
164 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]165 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]167 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]168 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]170 "message": "A String", # [Output Only] An optional, human-readable error message.
171 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]172 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 },
174 ],
175 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]177 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]178 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179 },
180 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]181 "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182 "message": "A String", # [Output Only] A human-readable description of the warning code.
183 "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.
184 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
185 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]186 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]188 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]189 },
190 ],
191 },
192 },
193 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 "warning": { # [Output Only] Informational warning message.
195 "message": "A String", # [Output Only] A human-readable description of the warning code.
196 "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.
197 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
198 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
199 {
200 "value": "A String", # [Output Only] A warning data value corresponding to the key.
201 "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).
202 },
203 ],
204 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]205 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]206 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
212 <pre>Retrieves the next page of results.
213
214Args:
215 previous_request: The request for the previous page. (required)
216 previous_response: The response from the request for the previous page. (required)
217
218Returns:
219 A request object that you can call 'execute()' on to request the next
220 page. Returns None if there are no more items in the collection.
221 </pre>
222</div>
223
224<div class="method">
225 <code class="details" id="delete">delete(project, operation)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]226 <pre>Deletes the specified Operations resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227
228Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]229 project: string, Project ID for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 operation: string, Name of the Operations resource to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="get">get(project, operation)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 <pre>Retrieves the specified Operations resource. Gets a list of operations by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237
238Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]239 project: string, Project ID for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]240 operation: string, Name of the Operations resource to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]241
242Returns:
243 An object of the form:
244
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 { # Represents an Operation resource.
246 #
247 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
248 #
249 # Operations can be global, regional or zonal.
250 # - For global operations, use the globalOperations resource.
251 # - For regional operations, use the regionOperations resource.
252 # - For zonal operations, use the zonalOperations resource.
253 #
254 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]255 "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]256 "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]257 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]258 "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]259 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
261 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]262 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 "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.
264 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]265 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
267 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]268 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]269 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]270 "message": "A String", # [Output Only] A human-readable description of the warning code.
271 "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.
272 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
273 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]275 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]276 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 },
278 ],
279 },
280 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]281 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]282 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
283 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]284 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]286 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]287 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]289 "message": "A String", # [Output Only] An optional, human-readable error message.
290 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]291 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 },
293 ],
294 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]296 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]297 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 }</pre>
299</div>
300
301<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]302 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 <pre>Retrieves a list of Operation resources contained within the specified project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304
305Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]306 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]307 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
308
309You 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.
310
311Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]312 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313 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]314 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 <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]315
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]317
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]319
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320To 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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321
322Returns:
323 An object of the form:
324
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]325 { # Contains a list of Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]326 "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]327 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]328 "items": [ # [Output Only] A list of Operation resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 { # Represents an Operation resource.
330 #
331 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
332 #
333 # Operations can be global, regional or zonal.
334 # - For global operations, use the globalOperations resource.
335 # - For regional operations, use the regionOperations resource.
336 # - For zonal operations, use the zonalOperations resource.
337 #
338 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339 "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]340 "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]341 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342 "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]343 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]344 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
345 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]346 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]347 "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.
348 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]349 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]350 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
351 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]352 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]353 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]354 "message": "A String", # [Output Only] A human-readable description of the warning code.
355 "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.
356 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
357 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]358 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]359 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]360 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]361 },
362 ],
363 },
364 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]365 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]366 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
367 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]368 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]370 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]371 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]372 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]373 "message": "A String", # [Output Only] An optional, human-readable error message.
374 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]375 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]376 },
377 ],
378 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]379 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]380 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]381 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]382 },
383 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 "warning": { # [Output Only] Informational warning message.
385 "message": "A String", # [Output Only] A human-readable description of the warning code.
386 "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.
387 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
388 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
389 {
390 "value": "A String", # [Output Only] A warning data value corresponding to the key.
391 "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).
392 },
393 ],
394 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]395 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]396 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]397 }</pre>
398</div>
399
400<div class="method">
401 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
402 <pre>Retrieves the next page of results.
403
404Args:
405 previous_request: The request for the previous page. (required)
406 previous_response: The response from the request for the previous page. (required)
407
408Returns:
409 A request object that you can call 'execute()' on to request the next
410 page. Returns None if there are no more items in the collection.
411 </pre>
412</div>
413
414</body></html>