Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / compute_v1.firewalls.html
blob: caa017b98854a11fccbae16b9fa4803a1a6dc76a [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.firewalls.html">firewalls</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, firewall)</a></code></p>
79<p class="firstline">Deletes the specified firewall resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, firewall)</a></code></p>
82<p class="firstline">Returns the specified firewall resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a firewall 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 firewall 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="#patch">patch(project, firewall, body)</a></code></p>
94<p class="firstline">Updates the specified firewall resource with the data included in the request. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, firewall, body)</a></code></p>
97<p class="firstline">Updates the specified firewall resource with the data included in the request.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, firewall)</code>
101 <pre>Deletes the specified firewall resource.
102
103Args:
104 project: string, Name of the project scoping this request. (required)
105 firewall: string, Name of the firewall resource to delete. (required)
106
107Returns:
108 An object of the form:
109
110 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]111 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
112 "clientOperationId": "A String",
113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
114 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
115 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
116 "operationType": "A String",
117 "httpErrorMessage": "A String",
118 "progress": 42,
119 "httpErrorStatusCode": 42,
120 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
121 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
122 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
123 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 {
125 "message": "A String", # Optional human-readable details for this warning.
126 "code": "A String", # The warning type identifier for this warning.
127 "data": [ # Metadata for this warning in 'key: value' format.
128 {
129 "value": "A String", # A warning data value corresponding to the key.
130 "key": "A String", # A key for the warning data.
131 },
132 ],
133 },
134 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]135 "user": "A String",
136 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
137 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
138 "name": "A String", # [Output Only] Name of the resource (output only).
139 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
140 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
141 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]143 "message": "A String", # [Output Only] An optional, human-readable error message.
144 "code": "A String", # [Output Only] The error type identifier for this error.
145 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 },
147 ],
148 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]149 "endTime": "A String",
150 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
151 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="get">get(project, firewall)</code>
157 <pre>Returns the specified firewall resource.
158
159Args:
160 project: string, Name of the project scoping this request. (required)
161 firewall: string, Name of the firewall resource to return. (required)
162
163Returns:
164 An object of the form:
165
166 { # A firewall resource.
167 "kind": "compute#firewall", # Type of the resource.
168 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
169 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
170 "A String",
171 ],
172 "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
173 "A String",
174 ],
175 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
176 "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
177 "A String",
178 ],
179 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
180 {
181 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
182 "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
183 #
184 # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
185 "A String",
186 ],
187 },
188 ],
189 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
190 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
191 "selfLink": "A String", # Server defined URL for the resource (output only).
192 "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.
193 }</pre>
194</div>
195
196<div class="method">
197 <code class="details" id="insert">insert(project, body)</code>
198 <pre>Creates a firewall resource in the specified project using the data included in the request.
199
200Args:
201 project: string, Name of the project scoping this request. (required)
202 body: object, The request body. (required)
203 The object takes the form of:
204
205{ # A firewall resource.
206 "kind": "compute#firewall", # Type of the resource.
207 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
208 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
209 "A String",
210 ],
211 "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
212 "A String",
213 ],
214 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
215 "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
216 "A String",
217 ],
218 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
219 {
220 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
221 "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
222 #
223 # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
224 "A String",
225 ],
226 },
227 ],
228 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
229 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
230 "selfLink": "A String", # Server defined URL for the resource (output only).
231 "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.
232 }
233
234
235Returns:
236 An object of the form:
237
238 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]239 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
240 "clientOperationId": "A String",
241 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
242 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
243 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
244 "operationType": "A String",
245 "httpErrorMessage": "A String",
246 "progress": 42,
247 "httpErrorStatusCode": 42,
248 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
249 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
250 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
251 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]252 {
253 "message": "A String", # Optional human-readable details for this warning.
254 "code": "A String", # The warning type identifier for this warning.
255 "data": [ # Metadata for this warning in 'key: value' format.
256 {
257 "value": "A String", # A warning data value corresponding to the key.
258 "key": "A String", # A key for the warning data.
259 },
260 ],
261 },
262 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]263 "user": "A String",
264 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
265 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
266 "name": "A String", # [Output Only] Name of the resource (output only).
267 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
268 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
269 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]271 "message": "A String", # [Output Only] An optional, human-readable error message.
272 "code": "A String", # [Output Only] The error type identifier for this error.
273 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 },
275 ],
276 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]277 "endTime": "A String",
278 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
279 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
285 <pre>Retrieves the list of firewall resources available to the specified project.
286
287Args:
288 project: string, Name of the project scoping this request. (required)
289 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
290 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
291 filter: string, Optional. Filter expression for filtering listed resources.
292
293Returns:
294 An object of the form:
295
296 { # Contains a list of firewall resources.
297 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]298 "items": [ # A list of Firewall resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]299 { # A firewall resource.
300 "kind": "compute#firewall", # Type of the resource.
301 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
302 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
303 "A String",
304 ],
305 "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
306 "A String",
307 ],
308 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
309 "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
310 "A String",
311 ],
312 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
313 {
314 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
315 "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
316 #
317 # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
318 "A String",
319 ],
320 },
321 ],
322 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
323 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
324 "selfLink": "A String", # Server defined URL for the resource (output only).
325 "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.
326 },
327 ],
328 "kind": "compute#firewallList", # Type of resource.
329 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
330 "selfLink": "A String", # Server defined URL for this resource (output only).
331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
336 <pre>Retrieves the next page of results.
337
338Args:
339 previous_request: The request for the previous page. (required)
340 previous_response: The response from the request for the previous page. (required)
341
342Returns:
343 A request object that you can call 'execute()' on to request the next
344 page. Returns None if there are no more items in the collection.
345 </pre>
346</div>
347
348<div class="method">
349 <code class="details" id="patch">patch(project, firewall, body)</code>
350 <pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
351
352Args:
353 project: string, Name of the project scoping this request. (required)
354 firewall: string, Name of the firewall resource to update. (required)
355 body: object, The request body. (required)
356 The object takes the form of:
357
358{ # A firewall resource.
359 "kind": "compute#firewall", # Type of the resource.
360 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
361 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
362 "A String",
363 ],
364 "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
365 "A String",
366 ],
367 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
368 "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
369 "A String",
370 ],
371 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
372 {
373 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
374 "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
375 #
376 # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
377 "A String",
378 ],
379 },
380 ],
381 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
382 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
383 "selfLink": "A String", # Server defined URL for the resource (output only).
384 "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.
385 }
386
387
388Returns:
389 An object of the form:
390
391 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]392 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
393 "clientOperationId": "A String",
394 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
395 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
396 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
397 "operationType": "A String",
398 "httpErrorMessage": "A String",
399 "progress": 42,
400 "httpErrorStatusCode": 42,
401 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
402 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
403 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
404 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]405 {
406 "message": "A String", # Optional human-readable details for this warning.
407 "code": "A String", # The warning type identifier for this warning.
408 "data": [ # Metadata for this warning in 'key: value' format.
409 {
410 "value": "A String", # A warning data value corresponding to the key.
411 "key": "A String", # A key for the warning data.
412 },
413 ],
414 },
415 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]416 "user": "A String",
417 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
418 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
419 "name": "A String", # [Output Only] Name of the resource (output only).
420 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
421 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
422 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]423 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]424 "message": "A String", # [Output Only] An optional, human-readable error message.
425 "code": "A String", # [Output Only] The error type identifier for this error.
426 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]427 },
428 ],
429 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]430 "endTime": "A String",
431 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
432 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]433 }</pre>
434</div>
435
436<div class="method">
437 <code class="details" id="update">update(project, firewall, body)</code>
438 <pre>Updates the specified firewall resource with the data included in the request.
439
440Args:
441 project: string, Name of the project scoping this request. (required)
442 firewall: string, Name of the firewall resource to update. (required)
443 body: object, The request body. (required)
444 The object takes the form of:
445
446{ # A firewall resource.
447 "kind": "compute#firewall", # Type of the resource.
448 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
449 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
450 "A String",
451 ],
452 "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
453 "A String",
454 ],
455 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
456 "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
457 "A String",
458 ],
459 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
460 {
461 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be one of the following well known protocol strings ["tcp", "udp", "icmp", "esp", "ah", "sctp"], or the IP protocol number.
462 "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
463 #
464 # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
465 "A String",
466 ],
467 },
468 ],
469 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
470 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
471 "selfLink": "A String", # Server defined URL for the resource (output only).
472 "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.
473 }
474
475
476Returns:
477 An object of the form:
478
479 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]480 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
481 "clientOperationId": "A String",
482 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
483 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
484 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
485 "operationType": "A String",
486 "httpErrorMessage": "A String",
487 "progress": 42,
488 "httpErrorStatusCode": 42,
489 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
490 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
491 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
492 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 {
494 "message": "A String", # Optional human-readable details for this warning.
495 "code": "A String", # The warning type identifier for this warning.
496 "data": [ # Metadata for this warning in 'key: value' format.
497 {
498 "value": "A String", # A warning data value corresponding to the key.
499 "key": "A String", # A key for the warning data.
500 },
501 ],
502 },
503 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]504 "user": "A String",
505 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
506 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
507 "name": "A String", # [Output Only] Name of the resource (output only).
508 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
509 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
510 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]511 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]512 "message": "A String", # [Output Only] An optional, human-readable error message.
513 "code": "A String", # [Output Only] The error type identifier for this error.
514 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]515 },
516 ],
517 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]518 "endTime": "A String",
519 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
520 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]521 }</pre>
522</div>
523
524</body></html>