Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / appengine_v1beta.apps.firewall.ingressRules.html
blob: 2f7f3229ffe26e40c90b88d38045aeeb3158c174 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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="appengine_v1beta.html">App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.firewall.html">firewall</a> . <a href="appengine_v1beta.apps.firewall.ingressRules.html">ingressRules</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(appsId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Creates a firewall rule for the application.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(appsId, ingressRulesId, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes the specified firewall rule.</p>
86<p class="toc_element">
87 <code><a href="#get">get(appsId, ingressRulesId, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the specified firewall rule.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]90 <code><a href="#list">list(appsId, pageToken=None, pageSize=None, matchingAddress=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Lists the firewall rules of an application.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(appsId, ingressRulesId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Updates the specified firewall rule.</p>
98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 <code class="details" id="batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]101 <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 &#x27;*&#x27; wildcard IP range, then an &quot;allow all&quot; rule is explicitly added to the end of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102
103Args:
104 appsId: string, Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 The object takes the form of:
107
108{ # Request message for Firewall.BatchUpdateIngressRules.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]109 &quot;ingressRules&quot;: [ # A list of FirewallRules to replace the existing set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]111 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
112 &quot;priority&quot;: 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.
113 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
114 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
115 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 ],
117 }
118
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
127 { # Response message for Firewall.UpdateAllIngressRules.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]128 &quot;ingressRules&quot;: [ # The full list of ingress FirewallRules for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]130 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
131 &quot;priority&quot;: 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.
132 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
133 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
134 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 ],
136 }</pre>
137</div>
138
139<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]140 <code class="details" id="create">create(appsId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 <pre>Creates a firewall rule for the application.
142
143Args:
144 appsId: string, Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 The object takes the form of:
147
148{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]149 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
150 &quot;priority&quot;: 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.
151 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
152 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
153 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154
155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
159
160Returns:
161 An object of the form:
162
163 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]164 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
165 &quot;priority&quot;: 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.
166 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
167 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
168 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169</div>
170
171<div class="method">
172 <code class="details" id="delete">delete(appsId, ingressRulesId, x__xgafv=None)</code>
173 <pre>Deletes the specified firewall rule.
174
175Args:
176 appsId: string, Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. (required)
177 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required)
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183Returns:
184 An object of the form:
185
186 { # 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:
187 # service Foo {
188 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
189 # }
190 # The JSON representation for Empty is empty JSON object {}.
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="get">get(appsId, ingressRulesId, x__xgafv=None)</code>
196 <pre>Gets the specified firewall rule.
197
198Args:
199 appsId: string, Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. (required)
200 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required)
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]210 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
211 &quot;priority&quot;: 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.
212 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
213 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
214 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215</div>
216
217<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]218 <code class="details" id="list">list(appsId, pageToken=None, pageSize=None, matchingAddress=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 <pre>Lists the firewall rules of an application.
220
221Args:
222 appsId: string, Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]223 pageToken: string, Continuation token for fetching the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 pageSize: integer, Maximum results to return per page.
225 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231Returns:
232 An object of the form:
233
234 { # Response message for Firewall.ListIngressRules.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]235 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
236 &quot;ingressRules&quot;: [ # The ingress FirewallRules for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]238 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
239 &quot;priority&quot;: 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.
240 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
241 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
242 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 ],
244 }</pre>
245</div>
246
247<div class="method">
248 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
249 <pre>Retrieves the next page of results.
250
251Args:
252 previous_request: The request for the previous page. (required)
253 previous_response: The response from the request for the previous page. (required)
254
255Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]256 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 page. Returns None if there are no more items in the collection.
258 </pre>
259</div>
260
261<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 <code class="details" id="patch">patch(appsId, ingressRulesId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 <pre>Updates the specified firewall rule.
264
265Args:
266 appsId: string, Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. (required)
267 ingressRulesId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]268 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 The object takes the form of:
270
271{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]272 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
273 &quot;priority&quot;: 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.
274 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
275 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
276 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277
278 updateMask: string, Standard field mask for the set of fields to be updated.
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
287 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]288 &quot;sourceRange&quot;: &quot;A String&quot;, # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character &quot;*&quot; to match all IPs equivalent to &quot;0/0&quot; and &quot;::/0&quot; 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.&lt;p&gt;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.
289 &quot;priority&quot;: 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.
290 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
291 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
292 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293</div>
294
295</body></html>