blob: 69fd4c80da31de7d71f2ee2f0f0cbe7ddc297565 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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.targetHttpsProxies.html">targetHttpsProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, targetHttpsProxy)</a></code></p>
79<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, targetHttpsProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetHttpsProxy resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</a></code></p>
94<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
95<p class="toc_element">
96 <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body)</a></code></p>
97<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, targetHttpsProxy)</code>
101 <pre>Deletes the specified TargetHttpsProxy resource.
102
103Args:
104 project: string, Project ID for this request. (required)
105 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
106
107Returns:
108 An object of the form:
109
110 { # An Operation resource, used to manage asynchronous API requests.
111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
112 "clientOperationId": "A String", # [Output Only] Reserved for future use.
113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
117 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
118 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
119 "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.
120 "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.
121 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
124 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
125 {
126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "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.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
130 {
131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
132 "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).
133 },
134 ],
135 },
136 ],
137 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
139 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
140 "name": "A String", # [Output Only] Name of the resource.
141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
142 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
143 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
144 {
145 "message": "A String", # [Output Only] An optional, human-readable error message.
146 "code": "A String", # [Output Only] The error type identifier for this error.
147 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
148 },
149 ],
150 },
151 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
153 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(project, targetHttpsProxy)</code>
159 <pre>Returns the specified TargetHttpsProxy resource.
160
161Args:
162 project: string, Project ID for this request. (required)
163 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
164
165Returns:
166 An object of the form:
167
168 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
169 "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
170 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
171 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
172 "A String",
173 ],
174 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
175 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
176 # - projects/project/global/urlMaps/url-map
177 # - global/urlMaps/url-map
178 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
179 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
181 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="insert">insert(project, body)</code>
187 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
188
189Args:
190 project: string, Project ID for this request. (required)
191 body: object, The request body. (required)
192 The object takes the form of:
193
194{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
195 "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
196 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
197 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
198 "A String",
199 ],
200 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
201 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
202 # - projects/project/global/urlMaps/url-map
203 # - global/urlMaps/url-map
204 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
205 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
206 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
207 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
208 }
209
210
211Returns:
212 An object of the form:
213
214 { # An Operation resource, used to manage asynchronous API requests.
215 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
216 "clientOperationId": "A String", # [Output Only] Reserved for future use.
217 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
218 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
219 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
221 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
222 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
223 "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.
224 "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.
225 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
226 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
227 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
228 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
229 {
230 "message": "A String", # [Output Only] A human-readable description of the warning code.
231 "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.
232 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
233 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
234 {
235 "value": "A String", # [Output Only] A warning data value corresponding to the key.
236 "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).
237 },
238 ],
239 },
240 ],
241 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
242 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
243 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
244 "name": "A String", # [Output Only] Name of the resource.
245 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
246 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
247 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
248 {
249 "message": "A String", # [Output Only] An optional, human-readable error message.
250 "code": "A String", # [Output Only] The error type identifier for this error.
251 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
252 },
253 ],
254 },
255 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
256 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
257 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
258 }</pre>
259</div>
260
261<div class="method">
262 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
263 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
264
265Args:
266 project: string, Project ID for this request. (required)
267 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.
268 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.
269 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
270
271The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
272
273For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
274
275Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
276
277The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
278
279Returns:
280 An object of the form:
281
282 { # Contains a list of TargetHttpsProxy resources.
283 "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.
284 "items": [ # A list of TargetHttpsProxy resources.
285 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
286 "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
288 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
289 "A String",
290 ],
291 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
292 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
293 # - projects/project/global/urlMaps/url-map
294 # - global/urlMaps/url-map
295 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
296 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
297 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
298 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
299 },
300 ],
301 "kind": "compute#targetHttpsProxyList", # Type of resource.
302 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
303 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
304 }</pre>
305</div>
306
307<div class="method">
308 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
309 <pre>Retrieves the next page of results.
310
311Args:
312 previous_request: The request for the previous page. (required)
313 previous_response: The response from the request for the previous page. (required)
314
315Returns:
316 A request object that you can call 'execute()' on to request the next
317 page. Returns None if there are no more items in the collection.
318 </pre>
319</div>
320
321<div class="method">
322 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</code>
323 <pre>Replaces SslCertificates for TargetHttpsProxy.
324
325Args:
326 project: string, Project ID for this request. (required)
327 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SSL certificate for. (required)
328 body: object, The request body. (required)
329 The object takes the form of:
330
331{
332 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one SSL certificate must be specified.
333 "A String",
334 ],
335 }
336
337
338Returns:
339 An object of the form:
340
341 { # An Operation resource, used to manage asynchronous API requests.
342 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
343 "clientOperationId": "A String", # [Output Only] Reserved for future use.
344 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
345 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
346 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
347 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
348 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
349 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
350 "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.
351 "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.
352 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
353 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
354 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
355 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
356 {
357 "message": "A String", # [Output Only] A human-readable description of the warning code.
358 "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.
359 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
360 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
361 {
362 "value": "A String", # [Output Only] A warning data value corresponding to the key.
363 "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).
364 },
365 ],
366 },
367 ],
368 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
369 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
370 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
371 "name": "A String", # [Output Only] Name of the resource.
372 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
373 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
374 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
375 {
376 "message": "A String", # [Output Only] An optional, human-readable error message.
377 "code": "A String", # [Output Only] The error type identifier for this error.
378 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
379 },
380 ],
381 },
382 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
383 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
384 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
385 }</pre>
386</div>
387
388<div class="method">
389 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body)</code>
390 <pre>Changes the URL map for TargetHttpsProxy.
391
392Args:
393 project: string, Project ID for this request. (required)
394 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
395 body: object, The request body. (required)
396 The object takes the form of:
397
398{
399 "urlMap": "A String",
400 }
401
402
403Returns:
404 An object of the form:
405
406 { # An Operation resource, used to manage asynchronous API requests.
407 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
408 "clientOperationId": "A String", # [Output Only] Reserved for future use.
409 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
410 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
411 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
412 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
413 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
414 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
415 "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.
416 "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.
417 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
418 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
419 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
420 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
421 {
422 "message": "A String", # [Output Only] A human-readable description of the warning code.
423 "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.
424 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
425 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
426 {
427 "value": "A String", # [Output Only] A warning data value corresponding to the key.
428 "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).
429 },
430 ],
431 },
432 ],
433 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
434 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
435 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
436 "name": "A String", # [Output Only] Name of the resource.
437 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
438 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
439 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
440 {
441 "message": "A String", # [Output Only] An optional, human-readable error message.
442 "code": "A String", # [Output Only] The error type identifier for this error.
443 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
444 },
445 ],
446 },
447 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
448 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
449 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
450 }</pre>
451</div>
452
453</body></html>