Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / appengine_v1beta.apps.firewall.ingressRules.html
blob: f836aa63af6bd671c270de4853a38e77e8be2deb [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <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]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">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]93 <code><a href="#list">list(appsId, matchingAddress=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <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]100<p class="firstline">Updates the specified firewall rule.</p>
101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code class="details" id="batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 &#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]105
106Args:
107 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]108 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 The object takes the form of:
110
111{ # Request message for Firewall.BatchUpdateIngressRules.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;ingressRules&quot;: [ # A list of FirewallRules to replace the existing set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]114 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]115 &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. 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.
116 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]117 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;ingressRules&quot;: [ # The full list of ingress FirewallRules for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]134 &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. 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.
135 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]136 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]137 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 ],
139 }</pre>
140</div>
141
142<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 <code class="details" id="close">close()</code>
144 <pre>Close httplib2 connections.</pre>
145</div>
146
147<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 <code class="details" id="create">create(appsId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]157 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]158 &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. 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.
159 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]160 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]161}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]172 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &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. 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.
174 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]175 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]176 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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 {}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]214 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]215 &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. 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.
216 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]217 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]218 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219</div>
220
221<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]222 <code class="details" id="list">list(appsId, matchingAddress=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]228 pageToken: string, Continuation token for fetching the next page of results.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]229 pageSize: integer, Maximum results to return per page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]239 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &quot;ingressRules&quot;: [ # The ingress FirewallRules for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 { # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]242 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]243 &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. 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.
244 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]245 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]246 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 ],
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 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]261 page. Returns None if there are no more items in the collection.
262 </pre>
263</div>
264
265<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266 <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]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]272 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]276 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]277 &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. 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.
278 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]279 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]280}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]292 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]293 &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. 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.
294 &quot;action&quot;: &quot;A String&quot;, # The action to take on matched requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]295 &quot;description&quot;: &quot;A String&quot;, # An optional string description of this rule. This field has a maximum length of 100 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]296 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297</div>
298
299</body></html>