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="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.firewall.html">firewall</a> . <a href="appengine_v1.apps.firewall.ingressRules.html">ingressRules</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(appsId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a firewall rule for the application.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(appsId, ingressRulesId, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified firewall rule.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(appsId, ingressRulesId, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the specified firewall rule.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(appsId, matchingAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists the firewall rules of an application.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(appsId, ingressRulesId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates the specified firewall rule.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</code> 104 <pre>Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list. 105 106Args: 107 appsId: string, Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. (required) 108 body: object, The request body. 109 The object takes the form of: 110 111{ # Request message for Firewall.BatchUpdateIngressRules. 112 "ingressRules": [ # A list of FirewallRules to replace the existing set. 113 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 114 "action": "A String", # The action to take on matched requests. 115 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 116 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 117 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 118 }, 119 ], 120} 121 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # Response message for Firewall.UpdateAllIngressRules. 131 "ingressRules": [ # The full list of ingress FirewallRules for this application. 132 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 133 "action": "A String", # The action to take on matched requests. 134 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 135 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 136 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 137 }, 138 ], 139}</pre> 140</div> 141 142<div class="method"> 143 <code class="details" id="close">close()</code> 144 <pre>Close httplib2 connections.</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="create">create(appsId, body=None, x__xgafv=None)</code> 149 <pre>Creates a firewall rule for the application. 150 151Args: 152 appsId: string, Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. (required) 153 body: object, The request body. 154 The object takes the form of: 155 156{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 157 "action": "A String", # The action to take on matched requests. 158 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 159 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 160 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 161} 162 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 172 "action": "A String", # The action to take on matched requests. 173 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 174 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 175 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="delete">delete(appsId, ingressRulesId, x__xgafv=None)</code> 181 <pre>Deletes the specified firewall rule. 182 183Args: 184 appsId: string, Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. (required) 185 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required) 186 x__xgafv: string, V1 error format. 187 Allowed values 188 1 - v1 error format 189 2 - v2 error format 190 191Returns: 192 An object of the form: 193 194 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="get">get(appsId, ingressRulesId, x__xgafv=None)</code> 200 <pre>Gets the specified firewall rule. 201 202Args: 203 appsId: string, Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. (required) 204 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required) 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 214 "action": "A String", # The action to take on matched requests. 215 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 216 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 217 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 218}</pre> 219</div> 220 221<div class="method"> 222 <code class="details" id="list">list(appsId, matchingAddress=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 223 <pre>Lists the firewall rules of an application. 224 225Args: 226 appsId: string, Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. (required) 227 matchingAddress: string, A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. 228 pageSize: integer, Maximum results to return per page. 229 pageToken: string, Continuation token for fetching the next page of results. 230 x__xgafv: string, V1 error format. 231 Allowed values 232 1 - v1 error format 233 2 - v2 error format 234 235Returns: 236 An object of the form: 237 238 { # Response message for Firewall.ListIngressRules. 239 "ingressRules": [ # The ingress FirewallRules for this application. 240 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 241 "action": "A String", # The action to take on matched requests. 242 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 243 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 244 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 245 }, 246 ], 247 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 253 <pre>Retrieves the next page of results. 254 255Args: 256 previous_request: The request for the previous page. (required) 257 previous_response: The response from the request for the previous page. (required) 258 259Returns: 260 A request object that you can call 'execute()' on to request the next 261 page. Returns None if there are no more items in the collection. 262 </pre> 263</div> 264 265<div class="method"> 266 <code class="details" id="patch">patch(appsId, ingressRulesId, body=None, updateMask=None, x__xgafv=None)</code> 267 <pre>Updates the specified firewall rule. 268 269Args: 270 appsId: string, Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. (required) 271 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required) 272 body: object, The request body. 273 The object takes the form of: 274 275{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 276 "action": "A String", # The action to take on matched requests. 277 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 278 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 279 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 280} 281 282 updateMask: string, Standard field mask for the set of fields to be updated. 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 288Returns: 289 An object of the form: 290 291 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. 292 "action": "A String", # The action to take on matched requests. 293 "description": "A String", # An optional string description of this rule. This field has a maximum length of 400 characters. 294 "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. 295 "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. 296}</pre> 297</div> 298 299</body></html>