Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / compute_v1beta12.firewalls.html
blob: 76207602d81aa261afbbfca4301fe9a4fc22566f [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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_v1beta12.html">Compute Engine API</a> . <a href="compute_v1beta12.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 {
111 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
112 "kind": "compute#operation", # Type of the resource.
113 "name": "A String", # Name of the resource.
114 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
115 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
116 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
117 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
118 "errors": [ # The array of errors encountered while processing this operation.
119 {
120 "message": "A String", # An optional, human-readable error message.
121 "code": "A String", # The error type identifier for this error.
122 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
123 },
124 ],
125 },
126 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
127 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
128 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
129 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
130 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
131 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
132 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
133 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
134 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
135 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
136 "selfLink": "A String", # Server defined URL for the resource (output only).
137 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="get">get(project, firewall)</code>
143 <pre>Returns the specified firewall resource.
144
145Args:
146 project: string, Name of the project scoping this request. (required)
147 firewall: string, Name of the firewall resource to return. (required)
148
149Returns:
150 An object of the form:
151
152 {
153 "kind": "compute#firewall", # Type of the resource.
154 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
155 "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.
156 "A String",
157 ],
158 "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.
159 "A String",
160 ],
161 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
162 "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.
163 "A String",
164 ],
165 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
166 {
167 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
168 "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.
169 # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
170 "A String",
171 ],
172 },
173 ],
174 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
175 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
176 "selfLink": "A String", # Server defined URL for the resource (output only).
177 "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.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="insert">insert(project, body)</code>
183 <pre>Creates a firewall resource in the specified project using the data included in the request.
184
185Args:
186 project: string, Name of the project scoping this request. (required)
187 body: object, The request body. (required)
188 The object takes the form of:
189
190{
191 "kind": "compute#firewall", # Type of the resource.
192 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
193 "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.
194 "A String",
195 ],
196 "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.
197 "A String",
198 ],
199 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
200 "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.
201 "A String",
202 ],
203 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
204 {
205 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
206 "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.
207 # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
208 "A String",
209 ],
210 },
211 ],
212 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
213 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
214 "selfLink": "A String", # Server defined URL for the resource (output only).
215 "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.
216 }
217
218
219Returns:
220 An object of the form:
221
222 {
223 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
224 "kind": "compute#operation", # Type of the resource.
225 "name": "A String", # Name of the resource.
226 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
227 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
228 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
229 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
230 "errors": [ # The array of errors encountered while processing this operation.
231 {
232 "message": "A String", # An optional, human-readable error message.
233 "code": "A String", # The error type identifier for this error.
234 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
235 },
236 ],
237 },
238 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
239 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
240 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
241 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
242 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
243 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
244 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
245 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
246 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
247 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
248 "selfLink": "A String", # Server defined URL for the resource (output only).
249 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
255 <pre>Retrieves the list of firewall resources available to the specified project.
256
257Args:
258 project: string, Name of the project scoping this request. (required)
259 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
260 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
261 filter: string, Optional. Filter expression for filtering listed resources.
262
263Returns:
264 An object of the form:
265
266 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]267 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]268 "items": [ # The firewall resources.
269 {
270 "kind": "compute#firewall", # Type of the resource.
271 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
272 "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.
273 "A String",
274 ],
275 "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.
276 "A String",
277 ],
278 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
279 "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.
280 "A String",
281 ],
282 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
283 {
284 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
285 "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.
286 # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
287 "A String",
288 ],
289 },
290 ],
291 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
292 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
293 "selfLink": "A String", # Server defined URL for the resource (output only).
294 "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.
295 },
296 ],
297 "kind": "compute#firewallList", # Type of resource.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]298 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
299 "selfLink": "A String", # Server defined URL for this resource (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]300 }</pre>
301</div>
302
303<div class="method">
304 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
305 <pre>Retrieves the next page of results.
306
307Args:
308 previous_request: The request for the previous page. (required)
309 previous_response: The response from the request for the previous page. (required)
310
311Returns:
312 A request object that you can call 'execute()' on to request the next
313 page. Returns None if there are no more items in the collection.
314 </pre>
315</div>
316
317<div class="method">
318 <code class="details" id="patch">patch(project, firewall, body)</code>
319 <pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
320
321Args:
322 project: string, Name of the project scoping this request. (required)
323 firewall: string, Name of the firewall resource to update. (required)
324 body: object, The request body. (required)
325 The object takes the form of:
326
327{
328 "kind": "compute#firewall", # Type of the resource.
329 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
330 "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.
331 "A String",
332 ],
333 "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.
334 "A String",
335 ],
336 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
337 "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.
338 "A String",
339 ],
340 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
341 {
342 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
343 "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.
344 # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
345 "A String",
346 ],
347 },
348 ],
349 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
350 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
351 "selfLink": "A String", # Server defined URL for the resource (output only).
352 "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.
353 }
354
355
356Returns:
357 An object of the form:
358
359 {
360 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
361 "kind": "compute#operation", # Type of the resource.
362 "name": "A String", # Name of the resource.
363 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
364 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
365 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
366 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
367 "errors": [ # The array of errors encountered while processing this operation.
368 {
369 "message": "A String", # An optional, human-readable error message.
370 "code": "A String", # The error type identifier for this error.
371 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
372 },
373 ],
374 },
375 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
376 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
377 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
378 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
379 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
380 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
381 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
382 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
383 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
384 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
385 "selfLink": "A String", # Server defined URL for the resource (output only).
386 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
387 }</pre>
388</div>
389
390<div class="method">
391 <code class="details" id="update">update(project, firewall, body)</code>
392 <pre>Updates the specified firewall resource with the data included in the request.
393
394Args:
395 project: string, Name of the project scoping this request. (required)
396 firewall: string, Name of the firewall resource to update. (required)
397 body: object, The request body. (required)
398 The object takes the form of:
399
400{
401 "kind": "compute#firewall", # Type of the resource.
402 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
403 "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.
404 "A String",
405 ],
406 "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.
407 "A String",
408 ],
409 "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
410 "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.
411 "A String",
412 ],
413 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
414 {
415 "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
416 "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.
417 # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
418 "A String",
419 ],
420 },
421 ],
422 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
423 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
424 "selfLink": "A String", # Server defined URL for the resource (output only).
425 "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.
426 }
427
428
429Returns:
430 An object of the form:
431
432 {
433 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
434 "kind": "compute#operation", # Type of the resource.
435 "name": "A String", # Name of the resource.
436 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
437 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
438 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
439 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
440 "errors": [ # The array of errors encountered while processing this operation.
441 {
442 "message": "A String", # An optional, human-readable error message.
443 "code": "A String", # The error type identifier for this error.
444 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
445 },
446 ],
447 },
448 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
449 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
450 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
451 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
452 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
453 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
454 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
455 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
456 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
457 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
458 "selfLink": "A String", # Server defined URL for the resource (output only).
459 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
460 }</pre>
461</div>
462
463</body></html>