Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_alpha.regionOperations.html
blob: 1695ca9ac1666db10e9637500c3121e35168f314 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionOperations.html">regionOperations</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="#delete">delete(project, region, operation)</a></code></p>
79<p class="firstline">Deletes the specified region-specific Operations resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(project, region, operation)</a></code></p>
82<p class="firstline">Retrieves the specified region-specific Operations resource.</p>
83<p class="toc_element">
84 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Retrieves a list of Operation resources contained within the specified region.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#wait">wait(project, region, operation)</a></code></p>
91<p class="firstline">Waits for the specified region-specific 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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94 <code class="details" id="delete">delete(project, region, operation)</code>
95 <pre>Deletes the specified region-specific Operations resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]96
97Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98 project: string, Project ID for this request. (required)
99 region: string, Name of the region for this request. (required)
100 operation: string, Name of the Operations resource to delete. (required)
101</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(project, region, operation)</code>
106 <pre>Retrieves the specified region-specific Operations resource.
107
108Args:
109 project: string, Project ID for this request. (required)
110 region: string, Name of the region for this request. (required)
111 operation: string, Name of the Operations resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112
113Returns:
114 An object of the form:
115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 { # Represents an Operation resource.
117 #
118 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
119 #
120 # Operations can be global, regional or zonal.
121 # - For global operations, use the globalOperations resource.
122 # - For regional operations, use the regionOperations resource.
123 # - For zonal operations, use the zonalOperations resource.
124 #
125 # 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]126 "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]127 "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]128 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]129 "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]130 "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]131 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
134 "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.
135 "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.
136 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
137 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
138 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
139 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
140 {
141 "message": "A String", # [Output Only] A human-readable description of the warning code.
142 "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.
143 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
144 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
145 {
146 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 },
149 ],
150 },
151 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
154 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]155 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]158 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
159 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
160 {
161 "message": "A String", # [Output Only] An optional, human-readable error message.
162 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]163 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]164 },
165 ],
166 },
167 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
168 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]169 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 }</pre>
171</div>
172
173<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]174 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
175 <pre>Retrieves a list of Operation resources contained within the specified region.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176
177Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 project: string, Project ID for this request. (required)
179 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]180 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
181
182You 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.
183
184Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]185 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]186 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]187 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 <.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]190
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191You 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]192
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193To 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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194
195Returns:
196 An object of the form:
197
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 { # Contains a list of Operation resources.
199 "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]200 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]201 "items": [ # [Output Only] A list of Operation resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 { # Represents an Operation resource.
203 #
204 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
205 #
206 # Operations can be global, regional or zonal.
207 # - For global operations, use the globalOperations resource.
208 # - For regional operations, use the regionOperations resource.
209 # - For zonal operations, use the zonalOperations resource.
210 #
211 # 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]212 "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]213 "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]214 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 "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]216 "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]217 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]218 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]219 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
220 "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.
221 "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.
222 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
223 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
224 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
225 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
226 {
227 "message": "A String", # [Output Only] A human-readable description of the warning code.
228 "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.
229 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
230 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
231 {
232 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]233 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]234 },
235 ],
236 },
237 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
240 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]241 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]242 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]244 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
245 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
246 {
247 "message": "A String", # [Output Only] An optional, human-readable error message.
248 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]249 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 },
251 ],
252 },
253 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
254 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]255 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 },
257 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 "warning": { # [Output Only] Informational warning message.
259 "message": "A String", # [Output Only] A human-readable description of the warning code.
260 "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.
261 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
262 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
263 {
264 "value": "A String", # [Output Only] A warning data value corresponding to the key.
265 "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).
266 },
267 ],
268 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]269 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
270 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]271 }</pre>
272</div>
273
274<div class="method">
275 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
276 <pre>Retrieves the next page of results.
277
278Args:
279 previous_request: The request for the previous page. (required)
280 previous_response: The response from the request for the previous page. (required)
281
282Returns:
283 A request object that you can call 'execute()' on to request the next
284 page. Returns None if there are no more items in the collection.
285 </pre>
286</div>
287
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288<div class="method">
289 <code class="details" id="wait">wait(project, region, operation)</code>
290 <pre>Waits for the specified region-specific 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.
291
292Args:
293 project: string, Project ID for this request. (required)
294 region: string, Name of the region for this request. (required)
295 operation: string, Name of the Operations resource to return. (required)
296
297Returns:
298 An object of the form:
299
300 { # Represents an Operation resource.
301 #
302 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
303 #
304 # Operations can be global, regional or zonal.
305 # - For global operations, use the globalOperations resource.
306 # - For regional operations, use the regionOperations resource.
307 # - For zonal operations, use the zonalOperations resource.
308 #
309 # 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 ==)
310 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
311 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
312 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
313 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
314 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
315 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
316 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
317 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
318 "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.
319 "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.
320 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
321 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
322 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
323 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
324 {
325 "message": "A String", # [Output Only] A human-readable description of the warning code.
326 "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.
327 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
328 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
329 {
330 "value": "A String", # [Output Only] A warning data value corresponding to the key.
331 "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).
332 },
333 ],
334 },
335 ],
336 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
337 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
338 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
339 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
340 "name": "A String", # [Output Only] Name of the resource.
341 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
342 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
343 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
344 {
345 "message": "A String", # [Output Only] An optional, human-readable error message.
346 "code": "A String", # [Output Only] The error type identifier for this error.
347 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
348 },
349 ],
350 },
351 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
352 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
353 "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.
354 }</pre>
355</div>
356
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]357</body></html>