File: recaptchaenterprise_v1.projects.firewallpolicies.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (396 lines) | stat: -rw-r--r-- 30,857 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="recaptchaenterprise_v1.html">reCAPTCHA Enterprise API</a> . <a href="recaptchaenterprise_v1.projects.html">projects</a> . <a href="recaptchaenterprise_v1.projects.firewallpolicies.html">firewallpolicies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified firewall policy.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified firewall policy.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all firewall policies that belong to a project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified firewall policy.</p>
<p class="toc_element">
  <code><a href="#reorder">reorder(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reorders all firewall policies.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Args:
  parent: string, Required. The name of the project this policy applies to, in the format `projects/{project}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
  &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
    { # An individual action. Each action represents what to do if a policy matches.
      &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
      },
      &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
      },
      &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
      },
      &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
      },
      &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
        &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
        &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
      },
      &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
        &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
      },
    },
  ],
  &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
  &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
  &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A FirewallPolicy represents a single matching pattern and resulting actions to take.
  &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
    { # An individual action. Each action represents what to do if a policy matches.
      &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
      },
      &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
      },
      &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
      },
      &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
      },
      &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
        &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
        &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
      },
      &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
        &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
      },
    },
  ],
  &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
  &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
  &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified firewall policy.

Args:
  name: string, Required. The name of the policy to be deleted, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Returns the specified firewall policy.

Args:
  name: string, Required. The name of the requested policy, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A FirewallPolicy represents a single matching pattern and resulting actions to take.
  &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
    { # An individual action. Each action represents what to do if a policy matches.
      &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
      },
      &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
      },
      &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
      },
      &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
      },
      &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
        &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
        &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
      },
      &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
        &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
      },
    },
  ],
  &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
  &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
  &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns the list of all firewall policies that belong to a project.

Args:
  parent: string, Required. The name of the project to list the policies for, in the format `projects/{project}`. (required)
  pageSize: integer, Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.
  pageToken: string, Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to request to list firewall policies belonging to a project.
  &quot;firewallPolicies&quot;: [ # Policy details.
    { # A FirewallPolicy represents a single matching pattern and resulting actions to take.
      &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
        { # An individual action. Each action represents what to do if a policy matches.
          &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
          },
          &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
          },
          &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
          },
          &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
          },
          &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
            &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
            &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
          },
          &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
            &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
          },
        },
      ],
      &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
      &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
      &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results. It is set to empty if no policies remain in results.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the specified firewall policy.

Args:
  name: string, Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
  &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
    { # An individual action. Each action represents what to do if a policy matches.
      &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
      },
      &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
      },
      &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
      },
      &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
      },
      &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
        &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
        &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
      },
      &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
        &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
      },
    },
  ],
  &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
  &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
  &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

  updateMask: string, Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A FirewallPolicy represents a single matching pattern and resulting actions to take.
  &quot;actions&quot;: [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
    { # An individual action. Each action represents what to do if a policy matches.
      &quot;allow&quot;: { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
      },
      &quot;block&quot;: { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action denies access to a given page. The user gets an HTTP error code.
      },
      &quot;includeRecaptchaScript&quot;: { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
      },
      &quot;redirect&quot;: { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. # This action redirects the request to a reCAPTCHA interstitial to attach a token.
      },
      &quot;setHeader&quot;: { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action sets a custom header but allow the request to continue to the customer backend.
        &quot;key&quot;: &quot;A String&quot;, # Optional. The header key to set in the request to the backend server.
        &quot;value&quot;: &quot;A String&quot;, # Optional. The header value to set in the request to the backend server.
      },
      &quot;substitute&quot;: { # A substitute action transparently serves a different page than the one requested. # This action transparently serves a different page to an offending user.
        &quot;path&quot;: &quot;A String&quot;, # Optional. The address to redirect to. The target is a relative path in the current host. Example: &quot;/blog/404.html&quot;.
      },
    },
  ],
  &quot;condition&quot;: &quot;A String&quot;, # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
  &quot;description&quot;: &quot;A String&quot;, # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
  &quot;path&quot;: &quot;A String&quot;, # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}</pre>
</div>

<div class="method">
    <code class="details" id="reorder">reorder(parent, body=None, x__xgafv=None)</code>
  <pre>Reorders all firewall policies.

Args:
  parent: string, Required. The name of the project to list the policies for, in the format `projects/{project}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The reorder firewall policies request message.
  &quot;names&quot;: [ # Required. A list containing all policy names, in the new order. Each name is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The reorder firewall policies response message.
}</pre>
</div>

</body></html>